投稿
  1. 极客之音首页
  2. 技术随笔

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

小半 • • 技术随笔 • 阅读 90

导读：本篇文章讲解 教你搭建一个springcloud微服务项目框架，希望对大家有帮助，欢迎收藏，转发！站点地址：www.bmabk.com

目标：

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

内容：

1、新建一个maven空项目mrserver
在这里插入图片描述
2、删掉src文件且pom文件修改如下：
![在这里插入图片描述](https://img-blog.csdnimg.cn/0cde87dc851d4f38b2611a935ab81f26.png?x-oss-process=image/watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBA5oiR5Lmf5Y-v5Lul5piv5rWB5rWq55qE6K-X5Lq6,size_20,color_FFFFFF,t_70,g_se,x_16

<?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>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.13.RELEASE</version>
    </parent>

    <groupId>org.example</groupId>
    <artifactId>mrserver2</artifactId>
    <version>1.0-SNAPSHOT</version>
    <!--打包方式为pom-->
    <packaging>pom</packaging>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
        <cloud.alibaba.version>2.2.1.RELEASE</cloud.alibaba.version>
        <cloud.version>Hoxton.SR12</cloud.version>
        <mysql.version>8.0.23</mysql.version>
    </properties>
<dependencies>
 <!--父模块默认加上nacos、和openfeign依赖。子模块可直接继承-->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>

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

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
        </dependency>
    </dependencies>
    <!--dependencyManagement标签只声明一些依赖，但具体引用还是在子模块按需引用-->
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${cloud.version}</version>
                <type>pom</type>
                <!--scope等于import说明该依赖具有传递性-->
                <scope>import</scope>
            </dependency>

            <dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-alibaba-dependencies</artifactId>
                <version>${cloud.alibaba.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>


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

3、开始新建模块，且新建的模块同样选择maven空项目
在这里插入图片描述
在这里插入图片描述

修改新建auth模块的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">
    <parent>
        <artifactId>mrserver2</artifactId>
        <groupId>org.example</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>auth</artifactId>
    <!--打包方式改为jar-->
    <packaging>jar</packaging>

    <dependencies>
    <!--采用异步mvc框架：webflux ,底层基于netty实现-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-webflux</artifactId>
        </dependency>
    </dependencies>
</project>

4、继续增加一个user和一个getway模块。二者pom依赖分别如下：
user-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">
    <parent>
        <artifactId>mrserver2</artifactId>
        <groupId>org.example</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>user</artifactId>
    <packaging>jar</packaging>

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

getway-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">
    <parent>
        <artifactId>mrserver2</artifactId>
        <groupId>org.example</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>getway</artifactId>
    <packaging>jar</packaging>
<!-- springcloud getway 默认集成了webflux-->
    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-sleuth</artifactId>
        </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的使用也很简单，它可以让调用者像是在调本地方法一样调远程方法，透明了中间的调用过程。

版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容， 请发送邮件至 举报，一经查实，本站将立刻删除。

文章由极客之音整理，本文链接：https://www.bmabk.com/index.php/post/99045.html

赞 (0)
小半的头像小半
0 0

相关推荐

极客之音——专业性很强的中文编程技术网站，欢迎收藏到浏览器，订阅我们！