2. 程式人生 > 實用技巧 >SpringCloud-1-父工程的建立以及RestFul風格實現provider和consumer

SpringCloud-1-父工程的建立以及RestFul風格實現provider和consumer

阿新 • • 發佈：2020-10-09

SpringCloud----父工程的建立以及RestFul風格實現provider和consumer

目錄

1.父工程依賴

編寫pom文件

<?xml version="1.0" encoding="UTF-8"?>
<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.wang</groupId>
    <artifactId>SpringCloud</artifactId>
    <version>1.0-SNAPSHOT</version>
    <modules>
        <module>SpringCloud-API</module>
        <module>SpringCloud-provider-dept-8001</module>
    </modules>

    <!--打包方式 pom-->
    <packaging>pom</packaging>

    <!--在這裡管理版本號, 方便以後修改-->
    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <maven.compiler.source>14</maven.compiler.source>
        <maven.complier.target>14</maven.complier.target>
        <junit.version>4.12</junit.version>
        <lombok.version>1.18.12</lombok.version>
        <log4j.version>1.2.17</log4j.version>
    </properties>

    <!--dependencyManagement是個管理, 不會匯入庫-->
    <dependencyManagement>
        <dependencies>
            <!--SpringCloud的依賴-->
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>Greenwich.SR1</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <!--SpringBoot的依賴-->
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>2.2.5.RELEASE</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <!--資料庫-->
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <version>5.1.47</version>
            </dependency>
            <!--Druid-->
            <dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>druid</artifactId>
                <version>1.1.10</version>
            </dependency>
            <!--SpringBoot-Mybatis 啟動器-->
            <dependency>
                <groupId>org.mybatis.spring.boot</groupId>
                <artifactId>mybatis-spring-boot-starter</artifactId>
                <version>1.3.2</version>
            </dependency>
            <!--junit-->
            <dependency>
                <groupId>junit</groupId>
                <artifactId>junit</artifactId>
                <version>${junit.version}</version>
            </dependency>
            <!--lombok-->
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <version>${lombok.version}</version>
            </dependency>
            <!--log4j-->
            <dependency>
                <groupId>log4j</groupId>
                <artifactId>log4j</artifactId>
                <version>${log4j.version}</version>
            </dependency>
            <!--日誌-->
            <dependency>
                <groupId>ch.qos.logback</groupId>
                <artifactId>logback-core</artifactId>
                <version>1.2.3</version>
            </dependency>
        </dependencies>
    </dependencyManagement>

</project>

這裡有以下幾點要注意

  • 可以在properties標籤中管理版本號以及編譯器使用的JDK版本
  • 在dependencyManagement標籤中管理專案中要使用的全部依賴, 這裡不會匯入lib
  • 在dependency標籤中使用${XXX}引用properties管理的版本號
  • SpringBoot的版本以及Lombok的版本要注意是否與當前JDK匹配, 高版本的JDK要使用高版本的依賴,否則無法編譯(Lombok則無法打包到Maven)

2. Rest

編寫Restful風格的API介面

1. 服務拆分

  • 在API專案中寫實體類

  • 在provider中寫提供者的具體實現

2. 建立資料庫

在微服務中, 個服務對應一個數據庫, 同一個資料可能存在不同的資料庫, 因此我們需要一個欄位來表明該資料庫是哪一個, 這裡使用db_source欄位

3. SpringCloud-API

1. 匯入依賴

<?xml version="1.0" encoding="UTF-8"?>
<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">
    <parent>
        <artifactId>SpringCloud</artifactId>
        <groupId>com.wang</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>SpringCloud-API</artifactId>

    <!--當前的Module自己需要的依賴, 如果父依賴中已經配置了版本, 這裡就不用寫了-->
    <dependencies>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
    </dependencies>


</project>

注意

  • 在父專案中只是管理了依賴, 在這裡匯入依賴才會導包
  • 此處的依賴的版本號在父專案中管理, 不需要寫, 也不建議寫, 以防出現版本衝突

2. 編寫實體類

package com.wang.springcloud.pojo;

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

import java.io.Serializable;

@Data
@NoArgsConstructor
//支援鏈式寫法
@Accessors(chain = true)
public class Dept implements Serializable {

    private Long deptno;
    private String dname;
    //這個資料存在哪個資料庫的欄位 ==> 微服務, 一個服務對應一個數據庫, 同一個資料可能存在不同的資料庫
    private String db_source;

    public Dept(String dname) {
        this.dname = dname;
    }
}

4. SpringCloud-provider-dept-8001

這裡命名規範最好寫上埠號

1. 匯入依賴

<?xml version="1.0" encoding="UTF-8"?>
<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">
    <parent>
        <artifactId>SpringCloud</artifactId>
        <groupId>com.wang</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>SpringCloud-provider-dept-8001</artifactId>

    <dependencies>
        <!--我們需要拿到實體類, 所以要配置api module-->
        <dependency>
            <groupId>com.wang</groupId>
            <artifactId>SpringCloud-API</artifactId>
            <version>1.0-SNAPSHOT</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>
        <!--test-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-test</artifactId>
        </dependency>
        <!--web-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!--jetty-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jetty</artifactId>
        </dependency>
        <!--熱部署工具-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
        </dependency>
    </dependencies>

</project>

注意

  • 這裡由於進行了服務的拆分, 同時在父專案中指定了使用pom方式打包, 這裡想要使用API中的實體類, 需要匯入依賴

2. SpringBoot及Mybatis配置

1. SpringBoot配置
server:
  port: 8001

#mybatis配置
mybatis:
  type-aliases-package: com.wang.springcloud.pojo
  mapper-locations: classpath:mybatis/mapper/*.xml
  config-location: classpath:mybatis/mybatis-config.xml

#Spring的配置
spring:
  application:
    name: springcloud-provider-dept
  #資料來源
  datasource:
    type: com.alibaba.druid.pool.DruidDataSource
    driver-class-name: org.gjt.mm.mysql.Driver
    url: jdbc:mysql://localhost:3306/db01?useUnicode=true&characterEncoding=utf-8
    username: root
    password: 123456

注意

  • mybatis的config-location指定的是mybatis的配置檔案的路徑, mapper-locations指定的是mapper的路徑, 他們都在resources目錄下
  • 使用其他資料連線池, 要指定名字
2. Mybatis配置
<?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. Dao以及Service層

1. Dao
package com.wang.springcloud.dao;

import com.wang.springcloud.pojo.Dept;
import org.apache.ibatis.annotations.Mapper;
import org.springframework.stereotype.Repository;

import java.util.List;

@Mapper
@Repository
public interface DeptDao {

    boolean addDept(Dept dept);

    Dept queryById(Long deptno);

    List<Dept> queryAll();
}

注意

  • 這裡要寫@Mapper和Mybatis繫結

  • Dao層使用@Repository被SpringBoot接管介面

2. Service
1. Service介面
package com.wang.springcloud.service;

import com.wang.springcloud.pojo.Dept;

import java.util.List;

public interface DeptService {

    boolean addDept(Dept dept);

    Dept queryById(Long deptno);

    List<Dept> queryAll();
}
2. Service實現類
package com.wang.springcloud.service;

import com.wang.springcloud.dao.DeptDao;
import com.wang.springcloud.pojo.Dept;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.util.List;

@Service
public class DeptServiceImpl implements DeptService {

    @Autowired
    private DeptDao deptDao;

    @Override
    public boolean addDept(Dept dept) {
        return deptDao.addDept(dept);
    }

    @Override
    public Dept queryById(Long deptno) {
        return deptDao.queryById(deptno);
    }

    @Override
    public List<Dept> queryAll() {
        return deptDao.queryAll();
    }
}

注意

  • 這裡要使用自動裝配將Dao層的結果通過Service層傳遞到返回值中實現呼叫(實際上是執行Dao層對SQL的呼叫, 這裡方便以後擴充套件功能)
  • Service層的SpringBoot託管註解為@Service

4. Controller層

package com.wang.springcloud.controller;

import com.wang.springcloud.pojo.Dept;
import com.wang.springcloud.service.DeptService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.List;

//提供RestFul服務!
@RestController
public class DeptController {

    @Autowired
    private DeptService deptService;

    @PostMapping("/dept/add")
    public boolean addDept(Dept dept){
        return deptService.addDept(dept);
    }

    @GetMapping("/dept/get/{id}")
    public Dept get(@PathVariable("id") Long id){
        return deptService.queryById(id);
    }

    @GetMapping("/dept/list")
    public List<Dept> queryAll(){
        return deptService.queryAll();
    }
}

注意

  • 由於我們這裡是提供介面呼叫, 因此使用@RestController註解
  • 使用RestFul風格傳參, 需要配合@PathVariable註解
  • 提交資料使用Post請求, 提高安全性
  • 這裡需要自動裝配Service介面, 此處由於只有一個實現類, 可以直接裝配; 如果有多個實現類的話, 需要配合@Qualified註解指定實現類的名字

5. Mapper

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.wang.springcloud.dao.DeptDao">
    <insert id="addDept" parameterType="Dept">
        insert into db01.dept (dname, db_source)
        values (#{dname}, DATABASE());
    </insert>

    <select id="queryById" resultType="Dept" parameterType="Long">
        select * from db01.dept where deptno = #{deptno};
    </select>

    <select id="queryAll" resultType="Dept">
        select * from db01.dept;
    </select>
</mapper>

注意

  • 改造Mybatis的Config為Mapper, 要替換DOCTYPE以及http中的config為mapper
  • mapper標籤中不要忘了寫名稱空間和Dao層繫結

6. 編寫SpringBoot的啟動類

package com.wang.springcloud;

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

//啟動類
@SpringBootApplication
public class DeptProvider_8001 {
    public static void main(String[] args) {
        SpringApplication.run(DeptProvider_8001.class, args);
    }
}

注意

  • SpringBoot的啟動類的寫法如下
    • 新增@SpringBootApplication註解, 表明這是SpringBoot的主啟動類
    • 在psvm中呼叫SpringApplication.run方法, 並將該啟動類的class以及args作為引數

5. SpringCloud-consumer-dept-8080

1. 配置埠

server:
  port: 8080

2. 註冊RestTemplate

package com.wang.springcloud.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.client.RestTemplate;

@Configuration
public class ConfigBean {

    //註冊RestTemplate
    @Bean
    public RestTemplate getRestTemplate() {
        return new RestTemplate();
    }

}

3. 編寫Controller

package com.wang.springcloud.controller;

import com.wang.springcloud.pojo.Dept;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestTemplate;

import java.util.List;

@RestController
public class DeptConsumerController {
    //消費者, 不應該有service層!(為了實現解耦)
    //RestFul模板 ==> RestTemplate, 裡面有很多方法供我們直接呼叫, 需要註冊到Spring中
    //遠端呼叫provider的url

    //在ConfigBean中註冊了, 這裡可以直接自動裝配(AutoWired是按照型別自動裝配)
    //RestTemplate的方法 ==> url, 請求的實體(request), 響應的型別(response)Class<T>
    //RestTemplate實質上就是提供多種便捷訪問遠端http服務的方法, 是一個簡單的RestFul服務模板
    @Autowired
    private RestTemplate restTemplate;

    //這裡去http://localhost:8001/dept/{id}這個url拿資料
    //由於字首是固定的, 我們這裡利用常量寫死
    private static final String REST_URL_PREFIX = "http://localhost:8001";
    @RequestMapping("/consumer/dept/get/{id}")
    public Dept get(@PathVariable("id") Long id) {
        //由於我們在provider中的list是get方法, 這裡呼叫getForObject方法
        return restTemplate.getForObject(REST_URL_PREFIX + "/dept/get/" + id, Dept.class);
    }

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

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

}

注意

  • 消費者訪問應該解耦, 故不應該呼叫Service層的東西, 為了訪問Service提供的資源, 我們通過訪問提供者的URL實現資源的訪問!

  • 利用SpringBoot提供的RestTemplate模板, 我們可以方便的訪問遠端的http服務的方法(這一點與dubbo+zookeeper實現的功能很相似)

  • 使用RestTemplate之前, 一定要註冊!

  • RestTemplate中的方法的三個引數 : url, 請求的實體(request), 響應的型別(response)Class

  • 重複的url可以提取公共部分作為常量

4. 編寫主啟動類

package com.wang.springcloud;

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

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

5. 測試

注意, 測試的時候一定要同時把提供者開啟!

這裡利用postman測試

相關推薦

SpringCloud-1-父工程的建立以及RestFul風格實現provider和consumer

SpringCloud----父工程的建立以及RestFul風格實現provider和consumer 目錄SpringCloud----父工程的建立以及RestFul風格實現provider和consumer1.父工程依賴2. Rest1. 服務拆分2. 建立資料庫3. SpringCloud-API1. 匯入

beego快速建立一個Restful風格API專案及API文件自動化

技術標籤：Go 1.前提mysql的表已經建好 2.建立golang及beego環境 官方文件指南http://beego.me/quickstart

maven繼承父工程統一版本號的實現

一、建立一個maven工程 pom型別 　　統一管理依賴以及版本號 　　子工程不會使用所有的定義的依賴

SpringCloud專案建立 SpringCloud搭建（一） 聚合父工程搭建

1.建立聚合父工程Project 　　1.1  maven-archetype-site(更復雜的網站專案)  　　1.2 springcloud 版本和 springboot 對應的版本

Springboot建立子父工程過程圖解

這篇文章主要介紹了Springboot建立子父工程過程圖解,文中通過示例程式碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下

001-cloud5-6建立父工程-cloud2020的pom檔案報錯怎麼辦？

cloud2020的pom檔案報錯怎麼辦？cloud專案的druid依賴無法下載怎麼辦？ pom檔案cloud2020 最初版本[手打版-應該是沒啥問題]

04_1-微服務cloud整體聚合工程之建立父工程步驟

目錄1、New Project2、聚合總父工程名字3、 Maven選版本4、工程名字5、字元編碼6、註解生效啟用7、java編譯版本選88、File Type過濾9、配置父工程 pom 檔案

SpringCloud 父工程常用依賴

SpringCloud 父工程常用依賴 記得更新版本 <?xml version="1.0" encoding="UTF-8"?>

SpringCloud學習筆記（一）搭建父工程

SpringCloud是分散式微服務架構的一站式解決方案，十多種微服務架構落地技術的集合體，俗稱微服務全家桶

springcloud父工程新建

一、微服務cloud整體聚合父工程Project 1.New Project File->new->project 選擇Maven 點選【Next】

restful風格詳解

一.概念 RESTful架構，就是目前最流行的一種網際網路軟體架構。它結構清晰、符合標準、易於理解、擴充套件方便，所以正得到越來越多網站的採用。

Laravel5.1 框架模型建立與使用方法例項分析

本文例項講述了Laravel5.1 框架模型建立與使用方法。分享給大家供大家參考，具體如下：

Spring Boot 整合——MongoDB整合2（MongoDB實體建立以及簡單CRUD）

文章前面 關於版本 依賴 版本 springboot 2.0.8.RELEASE mongodb 4.0.14 本內容只是為了介紹mongodb最基礎的使用以及配置，作為一個知名的資料庫，其存在相當多的高階用法，展開來介紹內容會相當多，

Restful風格wcf呼叫

寫在前面 公司有個專案，需要和sharepoint整合，用到了restful，在網上查了一下，wcf方式來實現，還是很方便的，就採用了這種方式，至於web api，沒研究過，由於介面急著用，就採用wcf了，用起來也比較順手。

tp5.1 獲取專案根目錄以及子目錄

5.0和5.1的獲取方式是不一樣的 常量調整 5.1取消了所有的框架內建常量（不影響應用程式碼中的自定義常量），如需獲取，請使用think\\facade\\App類的內建方法以及think\\facade\\Env類獲取，下面給出的是5.0和5.1的常

總結建構函式，建立物件，以及類的實現

要總結這些，從問幾個問題開始。 一，什麼是類？ “類”這個概念，是面向物件（Object-Oriented，OO）的語言都有的一個標誌，通過“類”可以建立任意多個具有相同屬性和方法的物件。“類&r

RESTFUL風格的URL請求及引數接收

　　RESTFUL是一種網路應用程式的設計風格和開發方式，基於HTTP，可以使用XML格式定義或JSON格式定義。RESTFUL適用於移動網際網路廠商作為業務使能介面的場景，實現第三方OTT呼叫行動網路資源的功能，動作型別為新增

RestFul風格和JSON字串

RestFul風格 特點： 簡潔 高效 安全 @Controller public class RestFulController { //原來的: http://localhost:8080/add?a=1&b=2

[vue]子元件通過props獲取父元件資料以及使用watch解決動態資料不生效問題

父子元件的傳值，在Vue官方也寫得很清楚，父元件中使用v-bind繫結傳送，子元件使用props接收。

vue 呼叫 RESTful風格介面操作

首先是簡單的java介面程式碼 寫了四個讓前端請求的介面，以下為程式碼 @GetMapping(\"/v1/user/{username}/{password}\")