SpringCloud(1)---基於RestTemplate微服務項目案例

基於RestTemplate微服務項目

     在寫SpringCloud搭建微服務之前，我想先搭建一個不通過springcloud只通過SpringBoot和Mybatis進行模塊之間額通訊。然后在此基礎上再添加SpringCloud框架。

下面先對案例做個說明

      該項目有一個maven父模塊，其中里面有三個子模塊：

                                   serverspringcloud：整體父工程。

                            serverspringcloud-api：公共子模塊，放公共實體對象。

 serverspringcloud-provider-dept-8001：部門微服務提供者。

  serverspringcloud-consumer-dept-80：部門微服務消費者。調用部分微服務提供者接口進行CRUD操作。

 

一、構建父工程

主要步驟:

   (1) 創建一個Maven父工程並命名serverspringcloud

   (2)  打包方式為POM

   (3) 在pom.xml中定義各依賴的版本號（若Module中pom.xml的依賴沒有指定版本號，則會根據父工程的版本號加入依賴）

1、 創建一個Maven父工程

2、 打包方式為POM

 

3、 在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.jincou.springcloudrest</groupId>
  <artifactId>serverspringcloud</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.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>

    <build>
        <finalName>serverspringcloud</finalName>
        <resources>
            <resource>
                <directory>src/main/resources</directory>
                <filtering>true</filtering>
            </resource>
        </resources>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-resources-plugin</artifactId>
                <configuration>
                    <delimiters>
                        <delimit>$</delimit>
                    </delimiters>
                </configuration>
            </plugin>
        </plugins>
    </build>


<!-- 說明下當你剛開始創建父工程的時候是沒有下面這些信息的，當你在父工程下每新建一個子模塊那么在這里都會添加一個子模塊的信息-->
    <modules>
        <module>serverspringcloud-api</module>
        <module>serverspringcloud-provider-dept-8001</module>
        <module>serverspringcloud-consumer-dept-80</module>
    </modules>
</project>

 

二、構建serverspringcloud-api(公共子模塊)

 主要步驟

      (1) 在父工程下新建Maven的Module，打包方式為jar

      (2) 在該Module下pom.xml中加入其它需要的依賴

      (3) 完成后先clean一下Maven項目，然后再install提供給其它模塊調用 

 1、在父工程下新建Maven的Module，打包方式為jar

 

在創建完子模塊后看下pom.xml的Overview視圖的一些信息。

 

 2、 在該Module下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.jincou.springcloudrest</groupId>
    <artifactId>serverspringcloud</artifactId>
    <version>0.0.1-SNAPSHOT</version>
  </parent>
  <!-- 我在創建時沒有重新指明groupId那就默認用父類的groupId -->
  <artifactId>serverspringcloud-api</artifactId>
   <!-- 該子模塊下目前我並沒有添加新的jar -->
</project>

 3、我在這里面添加了一個Dept實體

 

Dept實體

package com.jincou.springcloud.entities;

import java.io.Serializable;


public class Dept implements Serializable
{
    private Long     deptno; // 主鍵
    private String     dname; // 部門名稱
    private String     db_source;// 來自那個數據庫，因為微服務架構可以一個服務對應一個數據庫，同一個信息被存儲到不同數據庫
    
    public Dept(String dname)
    {
        super();
        this.dname = dname;
    }

    public Dept(Long deptno, String dname, String db_source) {
        super();
        this.deptno = deptno;
        this.dname = dname;
        this.db_source = db_source;
    }

    public Dept() {
        super();
    }

    public Long getDeptno() {
        return deptno;
    }

    public void setDeptno(Long deptno) {
        this.deptno = deptno;
    }

    public String getDname() {
        return dname;
    }

    public void setDname(String dname) {
        this.dname = dname;
    }

    public String getDb_source() {
        return db_source;
    }

    public void setDb_source(String db_source) {
        this.db_source = db_source;
    }
    
    
}

 

 三、創建部門微服務提供者

  步驟：這個就比較復雜了，具體看下面的圖

下面就展示幾個比較重要的環節

 1、pom.xml文件

   （1）先看下pom.xml的Overview視圖的一些信息。

 

 （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.jincou.springcloudrest</groupId>
    <artifactId>serverspringcloud</artifactId>
    <version>0.0.1-SNAPSHOT</version>
  </parent>
  <artifactId>serverspringcloud-provider-dept-8001</artifactId>
  
  
  <dependencies>
        <!-- 引入自己定義的api通用包，可以使用Dept部門Entity -->
        <dependency>
         <groupId>com.jincou.springcloudrest</groupId>
            <artifactId>serverspringcloud-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>

2、application.yml

server:
  port: 8001            #端口號
  
mybatis:
  config-location: classpath:mybatis/mybatis.cfg.xml        # mybatis配置文件所在路徑
  type-aliases-package: com.jincou.springcloud.entities     # 所有Entity別名類所在包
  mapper-locations:
  - classpath:mybatis/mapper/**/*.xml                       # mapper映射文件
    
spring:
   application:
    name: serverspringcloud-dept             #這個名字很重要后期如果注入eureka就很重要
   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、MySQL表信息

4、DAO接口信息

@Mapper
public interface DeptDao
{
    public boolean addDept(Dept dept);//添加部門

    public Dept findById(Long id);   //通過id找該部門數據

    public List<Dept> findAll();     //查看所有部門
}

 5、Controller層類

@RestController
public class DeptController
{
    @Autowired
    private DeptService service;

   //添加部門接口
    @RequestMapping(value = "/dept/add", method = RequestMethod.POST)
    public boolean add(@RequestBody Dept dept)
    {
        return service.add(dept);
    }
    //通過部門id查找部門信息
    @RequestMapping(value = "/dept/get/{id}", method = RequestMethod.GET)
    public Dept get(@PathVariable("id") Long id)
    {
        return service.get(id);
    }
    //查找所有部門信息
    @RequestMapping(value = "/dept/list", method = RequestMethod.GET)
    public List<Dept> list()
    {
        return service.list();
    }
}

 6、測試

 先做個小測試，看數據庫連接是否成功，調用api模塊是否成功。

說明測試成功！

 

 四、創建部門微服務消費者

主要步驟如圖

 

1、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.jincou.springcloudrest</groupId>
    <artifactId>serverspringcloud</artifactId>
    <version>0.0.1-SNAPSHOT</version>
  </parent>
  <artifactId>serverspringcloud-consumer-dept-80</artifactId>
  <description>部門微服務消費者</description>



    <dependencies>
        <dependency><!-- 自己定義的api -->
              <groupId>com.jincou.springcloudrest</groupId>        
              <artifactId>serverspringcloud-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>

2、application.yml

server:
  port: 80

3、ConfigBean配置類

@Configuration
public class ConfigBean //    @Configuration配置   ConfigBean = applicationContext.xml
{ 
    @Bean public RestTemplate getRestTemplate()
    {
        return new RestTemplate();
    } 
}

4、DeptController_Consumer類

@RestController
public class DeptController_Consumer
{

    private static final String REST_URL_PREFIX = "http://localhost:8001";

    /**
     * 使用 使用restTemplate訪問restful接口非常的簡單粗暴無腦。 (url, requestMap,
     * ResponseBean.class)這三個參數分別代表 REST請求地址、請求參數、HTTP響應轉換被轉換成的對象類型。
     */
    @Autowired
    private RestTemplate restTemplate;

    @RequestMapping(value = "/consumer/dept/add")
    public boolean add(Dept dept)
    {
        return restTemplate.postForObject(REST_URL_PREFIX + "/dept/add", dept, Boolean.class);
    }

    @RequestMapping(value = "/consumer/dept/get/{id}")
    public Dept get(@PathVariable("id") Long id)
    {
        return restTemplate.getForObject(REST_URL_PREFIX + "/dept/get/" + id, Dept.class);
    }

    @SuppressWarnings("unchecked")
    @RequestMapping(value = "/consumer/dept/list")
    public List<Dept> list()
    {
        return restTemplate.getForObject(REST_URL_PREFIX + "/dept/list", List.class);
    }
}

5、測試

測試成功，當我調用消費者接口的時候，它會再去調用提供者的接口。

 

五、總結

     整個項目終於跑通，然后再來屢一下思路，其實還是蠻簡單的。

  （1）通過maven構建父子工程，一個個子模塊就是一個個獨立的進程（因為他們端口號都不一樣），也就是微服務。

   （2）模塊之間的調用只要把你需要的模塊放到你的pom.xml中，這樣就會打成jar包，就可以供該模塊調用。

   （3）接口之間的調用只要通過RestTemplate工具類就可以了。

 

最后本博客GitHub源碼：https://github.com/yudiandemingzi/restTemplatestudy