教你搭建一个springcloud微服务项目框架

目标：

用maven搭建一个springcloud微服务项目，使用nacos作为服务注册。集成springcloud getway、springcloud openfeign、springcloud sleuth等组件的使用
新建三个微服务：auth、user、getway。且每个微服务都将自己注册到nacos上，从外部访问任一服务需经过getway转发，其余两个服务之间内调通过openfeign。并通过springcloud sleuth记录服务之间调用的traceId。

内容：

1、新建一个maven空项目mrserver

2、删掉src文件且pom文件修改如下：

<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.0modelVersion>

    <parent>
        <groupId>org.springframework.bootgroupId>
        <artifactId>spring-boot-starter-parentartifactId>
        <version>2.2.13.RELEASEversion>
    parent>

    <groupId>org.examplegroupId>
    <artifactId>mrserver2artifactId>
    <version>1.0-SNAPSHOTversion>
    
    <packaging>pompackaging>

    <properties>
        <maven.compiler.source>8maven.compiler.source>
        <maven.compiler.target>8maven.compiler.target>
        <cloud.alibaba.version>2.2.1.RELEASEcloud.alibaba.version>
        <cloud.version>Hoxton.SR12cloud.version>
        <mysql.version>8.0.23mysql.version>
    properties>
<dependencies>
 
        <dependency>
            <groupId>com.alibaba.cloudgroupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discoveryartifactId>
        dependency>

        <dependency>
            <groupId>org.springframework.cloudgroupId>
            <artifactId>spring-cloud-starter-sleuthartifactId>
        dependency>

        <dependency>
            <groupId>org.springframework.cloudgroupId>
            <artifactId>spring-cloud-starter-openfeignartifactId>
        dependency>
    dependencies>
    
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloudgroupId>
                <artifactId>spring-cloud-dependenciesartifactId>
                <version>${cloud.version}version>
                <type>pomtype>
                
                <scope>importscope>
            dependency>

            <dependency>
                <groupId>com.alibaba.cloudgroupId>
                <artifactId>spring-cloud-alibaba-dependenciesartifactId>
                <version>${cloud.alibaba.version}version>
                <type>pomtype>
                <scope>importscope>
            dependency>
        dependencies>
    dependencyManagement>


    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.bootgroupId>
                <artifactId>spring-boot-maven-pluginartifactId>
            plugin>
        plugins>
    build>
project>

3、开始新建模块，且新建的模块同样选择maven空项目

修改新建auth模块的pom文件如下：

<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>mrserver2artifactId>
        <groupId>org.examplegroupId>
        <version>1.0-SNAPSHOTversion>
    parent>
    <modelVersion>4.0.0modelVersion>

    <artifactId>authartifactId>
    
    <packaging>jarpackaging>

    <dependencies>
    
        <dependency>
            <groupId>org.springframework.bootgroupId>
            <artifactId>spring-boot-starter-webfluxartifactId>
        dependency>
    dependencies>
project>

4、继续增加一个user和一个getway模块。二者pom依赖分别如下：
user-pom

<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>mrserver2artifactId>
        <groupId>org.examplegroupId>
        <version>1.0-SNAPSHOTversion>
    parent>
    <modelVersion>4.0.0modelVersion>

    <artifactId>userartifactId>
    <packaging>jarpackaging>

    <dependencies>
        <dependency>
            <groupId>org.springframework.bootgroupId>
            <artifactId>spring-boot-starter-webfluxartifactId>
        dependency>
    dependencies>
project>

getway-pom

<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>mrserver2artifactId>
        <groupId>org.examplegroupId>
        <version>1.0-SNAPSHOTversion>
    parent>
    <modelVersion>4.0.0modelVersion>

    <artifactId>getwayartifactId>
    <packaging>jarpackaging>

    <dependencies>
        <dependency>
            <groupId>org.springframework.cloudgroupId>
            <artifactId>spring-cloud-starter-gatewayartifactId>
        dependency>

        <dependency>
            <groupId>org.springframework.cloudgroupId>
            <artifactId>spring-cloud-starter-sleuthartifactId>
        dependency>
    dependencies>
project>

5、由于每个子模块建的都是maven项目，所以需要自己编写springboot启动类

6、每个子模块的启动类编写好后，开始完善yml文件
auth-bootstrap-yml

spring:
  application:
    name: authserver
  cloud:
    nacos:
      discovery:
        server-addr: 127.0.0.1:8848
#这个server配置可以放到application.yml里去写。
#也可放到nacos-config里后读取
server:
  port: 81

user-bootstrap-yml

spring:
  application:
    name: userserver
  cloud:
    nacos:
      discovery:
        server-addr: 127.0.0.1:8848
#这个server配置可以放到application.yml里去写。
#也可放到nacos-config里后读取
server:
  port: 82

getway-bootstrap-yml

spring:
  application:
    name: getwayserver
  cloud:
    nacos:
      discovery:
        server-addr: 127.0.0.1:8848

getway-application-yml

server:
  port: 80

spring:
  cloud:
    gateway:
      routes:
      #设置auth服务的匹配路由
        - id: authserver
          uri: lb://authserver
          predicates:
          - Path=/authserver/**
          filters:
          - StripPrefix=1
      #设置user服务的匹配路由
        - id: userserver
          uri: lb://userserver
          predicates:
          - Path=/userserver/**
#          - Header=yxjAuthencation,\d+
          filters:
         #StripPrefix=1 去掉一个前缀，比如：a/b/c.html -> b/c.html
          - StripPrefix=1

7、auth和user随便编写几个controller做测试，前提是controller路径最前面需带上各自服务名，跟getway里yml配置保持一直，比如：

8、启动nacos（默认是集群方式启动，需改成Standalone模式）再分别启动三个微服务

nacos默认访问地址：http://localhost:8848/nacos 账号密码默认都是nacos。登录后，可看到服务列表已经注册有3个服务

9、根据地址从外部调用一个auth服务看下效果

可以看到正常返回，说明调用成功了，且经过getway转发。因为调用的地址是localhost:80 而不是auth的localhost:81

10、springcloud sleuth的使用：还记得getway服务里引入的springcloud sleuth依赖吗，它会自动记录你这一个请求经过了哪些链路，走了哪些服务。看下效果

第一个ffe38941c6881bd4是父ID，第二个ffe38941c6881bd4是子ID。每个链路的最开始，父子ID都是同一个，而链路第二个路径上的父ID则是上一个路径的子ID，因为getway这里是链路的最开始，所以父子ID都一致。下一个auth服务的日志记录里，父ID则是getway的子ID。

继续验证，看auth服务日志：

这就是springcloud sleuth的简单使用。

11、springcloud openfeign的使用：回到auth服务编写的demo代码
有没有发现，auth服务的demo里还调用了一个demoFeign的demo方法。

package com.yxj.auth;

import com.yxj.auth.feign.DemoFeign;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RequestMapping("demo")
@RestController
public class DemoController {

    private Logger logger = LoggerFactory.getLogger(getClass());

    @Autowired
    private DemoFeign demoFeign;

    @GetMapping("a")
    public String demo(){
        String demo = demoFeign.demo();
        logger.info("authserver"+demo);
        return demo;
    }
}

DemoFeign 的代码实现：

package com.yxj.auth.feign;

import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.stereotype.Component;
import org.springframework.web.bind.annotation.GetMapping;

@FeignClient("getwayserver")//声明要调用的服务
@Component
public interface DemoFeign {

    @GetMapping("demo/a")//匹配好需调用的路径
    public String demo();
}

除此之外还需在使用openfeign(auth)服务的启动类上加一个@EnableFeignClients注解

然后来看下被调用的getway demo/a

package com.yxj.getway;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RequestMapping("demo")
@RestController
public class DemoController {

    private Logger logger = LoggerFactory.getLogger(getClass());

    @GetMapping("a")
    public String demo(){
        logger.info("getway::log");
        //返回一个getwaydemo
        return "getwaydemo";
    }
}

geway服务 demo返回一个getwaydemo。而上面auth服务将调用geway服务的返回值直接返回给了调用者，所以最终页面上呈现的是

openfeign的使用也很简单，它可以让调用者像是在调本地方法一样调远程方法，透明了中间的调用过程。

---