1. 程式人生 > >SpringCloud(二)Rest微服務構建案例

SpringCloud(二)Rest微服務構建案例


架構:

以Dept部門模組做一個微服務通用案例,Consumer消費者(Client)通過REST呼叫Provider提供者(Server)提供的服務。

microservice-parent父工程(Project)下初次帶著3個子模組(Module)

microservice-parent://父工程

——microservice-api       // 封裝的整體Entity/介面/公共配置等

——microservice-provider-dept-8001    //微服務落地的服務提供者

——microservice-consumer-dept-80     //微服務呼叫的客戶端使用

1、父工程構建步驟

1.1、構建專案

1.2、pom.xml

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>


  <groupId>com.nari</groupId>
  <artifactId>microservice-parent</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <packaging>pom</packaging>


  <properties>
   <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
   <maven.compiler.source>1.8</maven.compiler.source>
   <maven.compiler.target>1.8</maven.compiler.target>
   <junit.version>4.12</junit.version>
   <log4j.version>1.2.17</log4j.version>
   <lombok.version>1.16.18</lombok.version>
  </properties>


  <dependencyManagement>
   <dependencies>
     <dependency>
       <groupId>org.springframework.cloud</groupId>
       <artifactId>spring-cloud-dependencies</artifactId>
       <version>Dalston.SR1</version>
       <type>pom</type>
       <scope>import</scope>
     </dependency>
     <dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-dependencies</artifactId>
       <version>1.5.9.RELEASE</version>
       <type>pom</type>
       <scope>import</scope>
     </dependency>
     <dependency>
       <groupId>mysql</groupId>
       <artifactId>mysql-connector-java</artifactId>
       <version>5.0.4</version>
     </dependency>
     <dependency>
       <groupId>com.alibaba</groupId>
       <artifactId>druid</artifactId>
       <version>1.0.31</version>
     </dependency>
     <dependency>
       <groupId>org.mybatis.spring.boot</groupId>
       <artifactId>mybatis-spring-boot-starter</artifactId>
       <version>1.3.0</version>
     </dependency>
     <dependency>
       <groupId>ch.qos.logback</groupId>
       <artifactId>logback-core</artifactId>
       <version>1.2.3</version>
     </dependency>
     <dependency>
       <groupId>junit</groupId>
       <artifactId>junit</artifactId>
       <version>${junit.version}</version>
       <scope>test</scope>
     </dependency>
     <dependency>
       <groupId>log4j</groupId>
       <artifactId>log4j</artifactId>
       <version>${log4j.version}</version>
     </dependency>
   </dependencies>
  </dependencyManagement>
</project>

主要是定義POM檔案,將後續各個子模組公用的jar包等統一提出來,類似一個抽象父類。

2、API公共模組和部門Entity步驟

2.1、構建專案

在microservice-parent專案基礎上構建子模組專案。

建立完成後回到父工程檢視pom檔案的變化:

父工程pom下多了該模組依賴:

<modules>
        <module>microservice-api</module>
</modules>

2.2、pom.xml

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <parent>	<!-- 子類裡面顯示宣告才能有明確的繼承表現,無意外就是父類的預設版本否則自己定義 -->
    <groupId>com.nari</groupId>
    <artifactId>microservice-parent</artifactId>
    <version>0.0.1-SNAPSHOT</version>
  </parent>
  <artifactId>microservice-api</artifactId> <!-- 當前Module我自己叫什麼名字 -->
  
  <dependencies><!-- 當前Module需要用到的jar包,按自己需求新增,如果父類已經包含了,可以不用寫版本號 -->
	<dependency>
		<groupId>org.projectlombok</groupId>
		<artifactId>lombok</artifactId>
	</dependency>
	
 </dependencies>
</project>

2.3、新建部門Entity且配合Lombok使用

package com.nari.entities;

import java.io.Serializable;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.ToString;
import lombok.experimental.Accessors;

/**
 * 部門實體類:
 * 
 */
@NoArgsConstructor  //生成一個無引數的構造方法
@AllArgsConstructor //會生成一個包含所有變數的構造方法
@Data		//@Data 註解就可以有下面幾個註解的功能: @ToString、@Getter、@Setter、@EqualsAndHashCode、@NoArgsConstructor
		//注意的是,同時使用@Data 和 @AllArgsConstructor 後 ,預設的無參建構函式失效,如果需要它,要重新設定 @NoArgsConstructors
@Accessors(chain=true)  //用來配置lombok如何產生和顯示getters和setters的方法
@ToString
public class Dept implements Serializable{ //Dept(Entity) orm mysql->Dept(table) 類表關係對映
	private Long deptno; //主鍵
	private String dname; //部門名稱
	private String db_source; //來自那個資料庫,因為微服務架構可以一個服務對應一個數據庫,同一個資訊儲存到不同資料庫

}

mvn clean install後給其他模組引用,達到通用目的。也即需要用到部門實體的話,不用每個工程都定義一份,直接引用本模組 即可。

3、SpringCloud Rest微服務案例——部門服務提供者

3.1、構建專案

New Maven Module:

3.2、pom.xml

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <parent>
    <groupId>com.nari</groupId>
    <artifactId>microservice-parent</artifactId>
    <version>0.0.1-SNAPSHOT</version>
  </parent>
  <artifactId>microservice-provider-dept-8001</artifactId>
  
  <dependencies>
	<!-- 引入自己定義的api通用包,可以使用Dept部門Entity -->
	<dependency>
		<groupId>com.nari</groupId>
		<artifactId>microservice-api</artifactId>
		<version>${project.version}</version>
	</dependency>
	
	
	<dependency>
		<groupId>junit</groupId>
		<artifactId>junit</artifactId>
	</dependency>
	<dependency>
		<groupId>mysql</groupId>
		<artifactId>mysql-connector-java</artifactId>
	</dependency>
	<dependency>
		<groupId>com.alibaba</groupId>
		<artifactId>druid</artifactId>
	</dependency>
	<dependency>
		<groupId>ch.qos.logback</groupId>
		<artifactId>logback-core</artifactId>
	</dependency>
	<dependency>
		<groupId>org.mybatis.spring.boot</groupId>
		<artifactId>mybatis-spring-boot-starter</artifactId>
	</dependency>
	<dependency>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-jetty</artifactId>
	</dependency>
	<dependency>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-web</artifactId>
	</dependency>
	<dependency>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-test</artifactId>
	</dependency>
	<!-- 修改後立即生效,熱部署 -->
	<dependency>
		<groupId>org.springframework</groupId>
		<artifactId>springloaded</artifactId>
	</dependency>
	<dependency>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-devtools</artifactId>
	</dependency>
  </dependencies>
</project>

3.3、application.yml

server:
  port: 8001
  
mybatis:
  config-location: classpath:mybatis/mybatis.cfg.xml        # mybatis配置檔案所在路徑
  type-aliases-package: com.nari.entities    # 所有Entity別名類所在包
  mapper-locations:
  - classpath:mybatis/mapper/**/*.xml                       # mapper對映檔案
    
spring:
   application:
    name: dept-provider
   datasource:
    type: com.alibaba.druid.pool.DruidDataSource            # 當前資料來源操作型別
    driver-class-name: org.gjt.mm.mysql.Driver              # mysql驅動包
    url: jdbc:mysql://localhost:3306/cloudDB01              # 資料庫名稱
    username: root
    password: root
    dbcp2:
      min-idle: 5                                           # 資料庫連線池的最小維持連線數
      initial-size: 5                                       # 初始化連線數
      max-total: 5                                          # 最大連線數
      max-wait-millis: 200                                  # 等待連接獲取的最大超時時間

3.4、工程src/main/resources目錄下新建mybatis資料夾後新建mybatis.cfg.xml檔案

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
  PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
  "http://mybatis.org/dtd/mybatis-3-config.dtd">

<configuration>
	<settings>
		<setting name="cacheEnabled" value="true" /><!-- 二級快取開啟 -->
	</settings>
</configuration>

3.5、MySQL建立部門資料庫指令碼

DROP DATABASE IF EXISTS cloudDB01;
CREATE DATABASE cloudDB01 CHARACTER SET UTF8;
USE cloudDB01;
CREATE TABLE dept
(
  deptno BIGINT NOT NULL PRIMARY KEY AUTO_INCREMENT,
  dname VARCHAR(60),
  db_source   VARCHAR(60)
);
 
INSERT INTO dept(dname,db_source) VALUES('開發部',DATABASE());
INSERT INTO dept(dname,db_source) VALUES('人事部',DATABASE());
INSERT INTO dept(dname,db_source) VALUES('財務部',DATABASE());
INSERT INTO dept(dname,db_source) VALUES('市場部',DATABASE());
INSERT INTO dept(dname,db_source) VALUES('運維部',DATABASE());
 
SELECT * FROM dept;

3.6、DeptDao部門介面

package com.nari.dao;

import java.util.List;
import org.apache.ibatis.annotations.Mapper;
import com.nari.entities.Dept;

@Mapper
public interface DeptDao
{
	public boolean addDept(Dept dept);
	public Dept findById(Long id);
	public List<Dept> findAll();
}

3.7、工程src/main/resources/mybatis目錄下新建mapper資料夾後再建DeptMapper.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-mapper.dtd">

<mapper namespace="com.nari.dao.DeptDao">

	<select id="findById" resultType="Dept" parameterType="Long">
		select deptno,dname,db_source from dept where deptno=#{deptno};
	</select>
	<select id="findAll" resultType="Dept">
		select deptno,dname,db_source from dept;
	</select>
	<insert id="addDept" parameterType="Dept">
		INSERT INTO dept(dname,db_source) VALUES(#{dname},DATABASE());
	</insert>

</mapper>

3.8、DeptService部門服務介面

package com.nari.service;
import java.util.List;
import com.nari.entities.Dept;
public interface DeptService
{
	public boolean add(Dept dept);

	public Dept get(Long id);

	public List<Dept> list();
}

3.9、DeptServiceImpl部門服務介面機實現類

package com.nari.service.impl;

import java.util.List;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import com.nari.dao.DeptDao;
import com.nari.entities.Dept;
import com.nari.service.DeptService;

@Service
public class DeptServiceImpl implements DeptService
{
	@Autowired
	private DeptDao dao;
	
	//新增部門
	@Override
	public boolean add(Dept dept)
	{
		return dao.addDept(dept);
	}

	//根據id獲取部門資訊
	@Override
	public Dept get(Long id)
	{
		return dao.findById(id);
	}

	//獲取所有部門資訊
	@Override
	public List<Dept> list()
	{
		return dao.findAll();
	}

}

3.10、DeptController部門微服務提供者REST

package com.nari.controller;

import java.util.List;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.cloud.client.discovery.DiscoveryClient;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

import com.nari.entities.Dept;
import com.nari.service.DeptService;

@RestController
@RequestMapping("/provider/dept")
public class DeptController
{
	@Autowired
	private DeptService service;
	@Autowired
	private DiscoveryClient client;

	@RequestMapping(value = "/add", method = RequestMethod.POST)
	public boolean add(@RequestBody Dept dept)
	{
		return service.add(dept);
	}

	@RequestMapping(value = "/get/{id}", method = RequestMethod.GET)
	public Dept get(@PathVariable("id") Long id)
	{
		return service.get(id);
	}

	@RequestMapping(value = "/list", method = RequestMethod.GET)
	public List<Dept> list()
	{
		return service.list();
	}
}

3.11、主啟動類DeptProvider8001_App

package com.nari;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class DeptProvider8001_App
{
	public static void main(String[] args)
	{
		SpringApplication.run(DeptProvider8001_App.class, args);
	}
}

3.12、測試

4、SpringCloud Rest微服務案例——部門服務消費者

4.1、構建專案

在microservice-parent上構建消費端模組專案。

4.2、pom.xml

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <parent>
   <groupId>com.nari</groupId>
   <artifactId>microservicecloud</artifactId>
   <version>0.0.1-SNAPSHOT</version>
  </parent>

  <artifactId>microservice-consumer-dept-80</artifactId>
  <description>部門微服務消費者</description>

  <dependencies>
   <dependency><!-- 自己定義的api -->
     <groupId>com.atguigu.springcloud</groupId>
     <artifactId>microservicecloud-api</artifactId>
     <version>${project.version}</version>
   </dependency> 
   <dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-web</artifactId>
   </dependency>
   <!-- 修改後立即生效,熱部署 -->
   <dependency>
     <groupId>org.springframework</groupId>
     <artifactId>springloaded</artifactId>
   </dependency>
   <dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-devtools</artifactId>
   </dependency>   
  </dependencies>


</project>

4.3、application.yml

server:
  port: 80

4.4、新建DeptController_Consumer部門微服務消費者REST

package com.nari.controller;

import java.util.List;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestTemplate;

import com.nari.entities.Dept;
/**
 * 服務消費者:
 *
 */
@RestController
@RequestMapping("/consumer/dept")
public class DeptController_Consumer {
	
	private static final String REST_URL_PREFIX = "http://localhost:8001/provider/dept"; //http://注意一定要加上,否則會報異常
	
	/**
	 * 使用 使用restTemplate訪問restful介面非常的簡單粗暴。 (url, requestMap,
	 * ResponseBean.class)這三個引數分別代表 REST請求地址、請求引數、HTTP響應轉換被轉換成的物件型別。
	 */
	@Autowired
	private RestTemplate restTemplate;
	
	@RequestMapping(value = "/add", method = RequestMethod.POST)
	public boolean add(Dept dept) {
		String  url = REST_URL_PREFIX + "/add";
		return restTemplate.postForObject(url, dept, Boolean.class);
	}
	
	@RequestMapping(value = "/get/{id}", method = RequestMethod.GET)
	public Dept get(@PathVariable("id") Long id) {
		String url = REST_URL_PREFIX + "/get/" + id;
		return restTemplate.getForObject(url, Dept.class);
	}
	
	@SuppressWarnings("unchecked")
	@RequestMapping(value = "/list" , method = RequestMethod.GET)
	public List<Dept> list() {
		String url = REST_URL_PREFIX + "/list";
		return restTemplate.getForObject(url, List.class);
	}
	
	
}

4.5、DeptConsumer80_App主啟動類及注入RestTemplate

package com.nari;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import org.springframework.web.client.RestTemplate;

/**
 * 部門消費者啟動類:
 *
 */
@SpringBootApplication
public class DeptConsumer80_App {
	public static void main(String[] args) {
		SpringApplication.run(DeptConsumer80_App.class, args);
	}
	
	@Bean
	public RestTemplate getRestTemplate() {
		return new RestTemplate();
	}
}

4.6、測試

首先啟動DeptProvider8001_App服務提供者,然後啟動DeptConsumer80_App服務消費者,即可呼叫服務。