Spring cloud Alibaba 分布式微服務，配置 nacos + gateway + feign + hystrix

 

 

 

 

 

這篇隨筆本人2021/04/09 原創，應該目前看了這篇博客的人都能搭成功。

環境：IDEA ，JDK 1.8， Mysql 5.* 

項目配置：nacos + gateway + feign + hystrix + mybatis plus

mybatis plus 我有在另一篇博文里寫過，有興趣的可以去看：https://www.cnblogs.com/anpieBlog/p/14607131.html

很多初學者被網上各種博文搞得頭昏眼花，從第一步就開始創建項目，搞到最后也沒搞出來。

第一步：搭建Spring cloud Alibaba 需要先裝nacos服務。這里我使用的1.4.1

nacos服務下載地址：https://github.com/alibaba/nacos/releases/tag/1.4.1

下載完成后，不能直接雙擊startup.cmd運行，會報錯，需要進入cmd命令，使用命令行啟動

 

 

 這個樣子就算成功了。

第二步：創建父項目

 

 

 

 

 

 

 

 

 

 

 

 

 ali-nacos的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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <!--<parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.4.4</version>
        <relativePath/> &lt;!&ndash; lookup parent from repository &ndash;&gt;
    </parent>-->
    <groupId>com.anear</groupId>
    <artifactId>ali-nacos</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>pom</packaging>

    <!--<modules>
        <module>**</module>
        <module>**</module>
        <module>**</module> <!-- 配置子項目的地方，先注掉，后面一個個放開配置 -->
        <module>**</module>
        <module>**</module>
    </modules>-->
    <name>studycloud</name>
    <description>Demo project for Spring Boot</description>
    <properties>
        <java.version>1.8</java.version>
        <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>
        <mysql.version>8.0.23</mysql.version>
        <druid.version>1.1.16</druid.version>
        <mybatis.spring.boot.version>1.3.0</mybatis.spring.boot.version>
    </properties>
    <dependencyManagement>
        <dependencies>
            <!--spring boot 2.2.2-->
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>2.2.2.RELEASE</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <!--spring cloud Hoxton.SR1-->
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>Hoxton.SR1</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <!--spring cloud alibaba 2.1.0.RELEASE-->
            <dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-alibaba-dependencies</artifactId>
                <version>2.1.0.RELEASE</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <version>${mysql.version}</version>
            </dependency>
            <dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>druid</artifactId>
                <version>${druid.version}</version>
            </dependency>
            <dependency>
                <groupId>org.mybatis.spring.boot</groupId>
                <artifactId>mybatis-spring-boot-starter</artifactId>
                <version>${mybatis.spring.boot.version}</version>
            </dependency>
            <dependency>
                <groupId>junit</groupId>
                <artifactId>junit</artifactId>
                <version>${junit.version}</version>
            </dependency>
            <dependency>
                <groupId>log4j</groupId>
                <artifactId>log4j</artifactId>
                <version>${log4j.version}</version>
            </dependency>
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <version>${lombok.version}</version>
                <optional>true</optional>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <fork>true</fork>
                    <addResources>true</addResources>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

第三步：創建子項目

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 創建完之后，打開子項目user的pom 修改如下，指向父項目

 

 

 同事父項目的pom里配置子項目

 

 

 對父項目和子項目的pom文件分別右擊對maven進行reload

 

 

 這里的user項目就是一個服務，可以選擇用它來處理業務也可以選擇用它提供調用的接口。

 

 

 

<dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!--SpringCloud ailibaba sentinel-datasource-nacos 后續做持久化用到-->
        <dependency>
            <groupId>com.alibaba.csp</groupId>
            <artifactId>sentinel-datasource-nacos</artifactId>
        </dependency>
        <!--SpringCloud ailibaba sentinel -->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-sentinel</artifactId>
        </dependency>
        <!--openfeign-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
        </dependency>

 

 

 

<!-- 代碼生成 -->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
            <version>3.1.2</version>
        </dependency>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>2.2.0</version>
        </dependency>
        <!-- freemarker 模板引擎-->
        <dependency>
            <groupId>org.freemarker</groupId>
            <artifactId>freemarker</artifactId>
        </dependency>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-core</artifactId>
            <version>3.0.7.1</version>
        </dependency>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-extension</artifactId>
            <version>3.0.7.1</version>
        </dependency>

繼續對user的maven pom進行reload，jar就引進去了，下面開始自動生成，在這里我假設你已經建立好了mybatisplus文件夾，在其文件夾下創建一個類用來執行生成代碼。將下面代碼拷貝的類里，按照各自情況微調生成路徑以及數據庫連接信息。

package com.anear.aliuser.mybatisplus;

import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException;
import com.baomidou.mybatisplus.core.toolkit.StringUtils;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.InjectionConfig;
import com.baomidou.mybatisplus.generator.config.*;
import com.baomidou.mybatisplus.generator.config.po.TableInfo;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;

import java.util.*;

//演示例子，執行 main 方法控制台輸入模塊表名回車自動生成對應項目目錄中
public class MybatisPlusGenerator {

    /**
     * <p>
     * 讀取控制台內容
     * </p>
     */
    public static String scanner(String tip) {
        Scanner scanner = new Scanner(System.in);
        StringBuilder help = new StringBuilder();
        help.append("請輸入" + tip + "：");
        System.out.println(help.toString());
        if (scanner.hasNext()) {
            String ipt = scanner.next();
            if (StringUtils.isNotEmpty(ipt)) {
                return ipt;
            }
        }
        throw new MybatisPlusException("請輸入正確的" + tip + "！");
    }

    public static void main(String[] args) {
        AutoGenerator mpg = new AutoGenerator(); //整合配置 全局配置+數據源配置+策略配置+包名策略配置
        // 選擇 freemarker 引擎，默認 Velocity 需要在配置文件引入依賴
        mpg.setTemplateEngine(new FreemarkerTemplateEngine());
        // 1全局配置
        GlobalConfig gc = new GlobalConfig();
        gc.setAuthor("Anear");
        gc.setOutputDir("C://Users//Anear//IdeaProjects//ali-nacos//ali-user//src//main//java");
        gc.setFileOverride(false);// 是否覆蓋同名文件，默認是false
        gc.setIdType(IdType.AUTO);// 主鍵策略
        gc.setActiveRecord(true);// 不需要ActiveRecord特性的請改為false
        gc.setEnableCache(false);// XML 二級緩存
        gc.setBaseResultMap(true);// XML ResultMap 生成基本的resultmap
        gc.setBaseColumnList(false);// XML columList 生成基本的sql片段
        /* 自定義文件命名，注意 %s 會自動填充表實體屬性！ */
        gc.setMapperName("%sMapper");
        gc.setXmlName("%sMapper");
        gc.setServiceName("%sService");
        gc.setServiceImplName("%sServiceImpl");
        gc.setControllerName("%sController");
        mpg.setGlobalConfig(gc);

        // 2數據源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setDbType(DbType.MYSQL);
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("123456");
        dsc.setUrl("jdbc:mysql://localhost:3306/anear?serverTimezone=Hongkong&useUnicode=true&characterEncoding=utf8");
        mpg.setDataSource(dsc);

        // 3策略配置globalConfiguration中
        StrategyConfig strategy = new StrategyConfig();
        strategy.setEntityLombokModel(true);//實體類以lombok注解氏生產
        strategy.setRestControllerStyle(true);//controller以restFule風格
        // strategy.setCapitalMode(true);// 全局大寫命名 ORACLE 注意
        strategy.setNaming(NamingStrategy.underline_to_camel);// 表名生成策略 此處可以更換為underline_to_camel 下滑線轉駝峰
        strategy.setInclude(new String[]{"user"}); // 需要生成的表
        // strategy.setExclude(new String[]{"test"}); // 排除生成的表
        // 自定義實體父類
        // strategy.setSuperEntityClass("com.baomidou.demo.TestEntity");
        // 自定義實體，公共字段
        // strategy.setSuperEntityColumns(new String[] { "test_id", "age" });
        // 自定義 mapper 父類
        // strategy.setSuperMapperClass("com.baomidou.demo.TestMapper");
        // 自定義 service 父類
        // strategy.setSuperServiceClass("com.baomidou.demo.TestService");
        // 自定義 service 實現類父類
        // strategy.setSuperServiceImplClass("com.baomidou.demo.TestServiceImpl");
        // 自定義 controller 父類
        // strategy.setSuperControllerClass("com.baomidou.demo.TestController");
        // 【實體】是否生成字段常量（默認 false）
        // public static final String ID = "test_id";
        // strategy.setEntityColumnConstant(true);
        // 【實體】是否為構建者模型（默認 false）
        // public User setName(String name) {this.name = name; return this;}
        // strategy.setEntityBuilderModel(true);
        mpg.setStrategy(strategy);

        // 4包配置 修改包生成的名稱
        //pkConfig.setParent("com.imooc")
        //                          .setMapper("dao")//dao
        //                          .setService("service")//servcie
        //                          .setController("controller")//controller
        //                          .setEntity("entity")
        //                           .setXml("resource");//mapper.xml
        PackageConfig pc = new PackageConfig();
        pc.setParent("com.springboot.study").setController("controller").setMapper("dao");
        // pc.setModuleName("test");
        pc.setParent("com.anear.aliuser.mybatisplus");
        pc.setEntity("entity");
        pc.setMapper("mapper");
        pc.setController("controller");
        mpg.setPackageInfo(pc);

        // 注入自定義配置，可以在 VM 中使用 cfg.abc 【可無】
        InjectionConfig cfg = new InjectionConfig() {
            @Override
            public void initMap() {
                Map<String, Object> map = new HashMap<String, Object>();
                map.put("abc", this.getConfig().getGlobalConfig().getAuthor() +
                        "-mp");
                this.setMap(map);
            }
        };

        // 自定義 xxList.jsp 生成
        List<FileOutConfig> focList = new ArrayList<>();

         /*focList.add(new FileOutConfig("/template/list.jsp.vm") {
             @Override
             public String outputFile(TableInfo tableInfo) {
                // 自定義輸入文件名稱
                 return "D://workspace/study/springboot_mybatisplus_lombok/src/main/webapp/" + tableInfo.getEntityName() + ".jsp";
             }
         });
         cfg.setFileOutConfigList(focList);
         mpg.setCfg(cfg);*/


        // 調整 xml 生成目錄演示
        // 如果模板引擎是 freemarker
        String templatePath = "/templates/mapper.xml.ftl";
        // 如果模板引擎是 velocity
        // String templatePath = "/templates/mapper.xml.vm";
        focList.add(new FileOutConfig(templatePath) {
            @Override
            public String outputFile(TableInfo  tableInfo) {
                return "C://Users//Anear//IdeaProjects//ali-nacos//ali-user//src/main/resources/mybatis/" + tableInfo.getEntityName()+"Mapper" + ".xml";
            }
        });
        cfg.setFileOutConfigList(focList);
        mpg.setCfg(cfg);
        // 關閉默認 xml 生成，調整生成 至 根目錄
        TemplateConfig tc = new TemplateConfig();
        tc.setXml(null);
        mpg.setTemplate(tc);

        // 自定義模板配置，可以 copy 源碼 mybatis-plus/src/main/resources/templates 下面內容修改，
        // 放置自己項目的 src/main/resources/templates 目錄下, 默認名稱一下可以不配置，也可以自定義模板名稱
        // TemplateConfig tc = new TemplateConfig();
        // tc.setController("...");
        // tc.setEntity("...");
        // tc.setMapper("...");
        // tc.setXml("...");
        // tc.setService("...");
        // tc.setServiceImpl("...");
        // 如上任何一個模塊如果設置 空 OR Null 將不生成該模塊。
        // mpg.setTemplate(tc);

        // 執行生成
        mpg.execute();

        // 打印注入設置【可無】
        // System.err.println(mpg.getCfg().getMap().get("abc"));
    }
}

修改完后右鍵執行，你會看到.xml到controller它都自動幫你生成了，文件夾也幫你生成了

 

 

 為了使用它提供的CRUD，需要修改entity類與數據庫表名和字段對應。

 

隨便在controller里寫個接口，獲取數據。

 

 

 

 

啟動類里配置這五個注解，有開啟Feign，設置mapper映射，開始注冊與發現等，設置mapper映射時，建議自己先點出來mapper路徑，再加引號，防止路徑出錯。

 

 

 

 

 

 在配置文件里配置數據庫連接，開始啟動子項目ali-user

server.port=6001

spring.datasource.url=jdbc:mysql://localhost:3306/anear?useUnicode=true&characterEncoding=utf-8
spring.datasource.driverClassName=com.mysql.jdbc.Driver
spring.datasource.username=root
spring.datasource.password=123456

#mybatis-plus
# 如果是放在src/main/java目錄下 classpath:/com/yourpackage/*/mapper/*Mapper.xml
# 如果是放在resource目錄 classpath:/mapper/*Mapper.xml
#mybatis-plus.mapper-locations=classpath:mybatis/*.xml
#實體掃描，多個package用逗號或者分號分隔
mybatis-plus.type-aliases-package=com.anear.aliuser.mybatisplus.entity

 

 

 

 還記得你剛啟動的nacos服務嗎，它會給你個提示，訪問http://127.0.0.1:8848/ ，默認用戶名和密碼都是nacos，登陸進去配置列表是空的，請忽略我原先的配置

 

 

 

 新建一個配置

 

 

 

 

 

 可以看到我們添加了一個配置，回到我們的子項目ali-user，添加配置文件，配置對應內容，設置注冊到我們本機的nacos，重新啟動服務，會發現服務已經注冊到nacos上了。

mybatis:
  mapper-locations: classpath:mybatis/*.xml
#補上xml映射

 

 

 

 

 

 

 用剛才創建子項目的步驟繼續創建一個子項目，名叫ali-order，一樣使用mybatis plus進行自動生成

像下面這張圖，建個一樣的項目，在controller 里面 return “haha”;

 

 

 

 

 

 

 

 

 不要忘記在nacos服務上建個配置，再啟動項目

 

 

 

 

 

 我本地已經起了兩個子服務，測試一下吧

 

 

 到目前我們發現每個服務都可以用，並且這兩個服務都注冊到了nacos，分布式特點在於根據請求轉發選擇對應實例服務進行處理，來完成處理並發等等的能力，這里的網關采用gate way。

創建一個新的子項目，里面是空的，pom我會貼上，什么依賴都不要。單詞拼錯，懶得改了。

 

 

 

 

 

 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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>com.anear</groupId>
        <artifactId>ali-nacos</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.anear</groupId>
    <artifactId>ali-gateway</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>gateway</name>
    <description>Demo project for Spring Boot</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway</artifactId>
        </dependency>
        <!--SpringCloud ailibaba nacos -->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

 

 

 另外不要忘記配置ali-gateway

還要配置各服務的網關：新建application.yml，將下面代碼貼進去。

spring:
  application:
    name: ali-gateway
  cloud:
    nacos:
      discovery:
        server-addr: http://127.0.0.1:8848/
    gateway:
      discovery:
        locator:
          enabled: true
      routes:
        - id: ali-user
          uri: http://localhost:6001
          predicates:
            - Path=/user/**
        - id: ali-order
          uri: http://localhost:6002
          predicates:
            - Path=/order/**

下面這是我啟動的三個服務，user>6001,order>6002,gateway>6003,測試轉發是否可以

 

 

 

 

 

 

 

 

 我們用相同的6003接口，user 和 order 接口都能請求到，這說明我們的兩個服務成功被gateway代理了。

轉發代理可以，負載均衡和熔斷器在分布式里是必不可少的，下面配置熔斷器和服務調用feign。

由於我們再user和order里都在啟動類里添加了開啟feign注解，所以接下來將非常簡單就是先。

太累了，我不適合寫這么長的博客，我直接貼代碼吧。

調用方新建feign文件夾，專門用來調用其他服務的接口，再配一個實現類包。fallback是發生熔斷去的地方

 

熔斷發生處理類

 

 

 

 

 修改controller，調用ali-user的接口

 

 

 測試：

 

 

 我們通過6003 gateway網關服務請求ali-order服務，ali-order服務調用了ali-user服務，所以返回了user里面的xixi。

結束，下班。

對了，開啟熔斷的開關在配置文件里打開，

# open hystrix
feign.hystrix.enabled=true   

你可以關掉被調用的服務，再次請求，程序請求超市會根據熔斷機制返回你配置的熔斷處理。is Feign error.

這里面涉及很多原理，有時間且不明白的朋友有必要去了解了解，這篇博客只教你如何搭建。