• SpringCloud-Rest微服务工程的构建

    目录

    一、微服务架构总览

    二、创建Rest风格的微服务工程

             2.1 创建微服务父工程

    2.1.1 使用maven新建父工程

    2.1.2 字符编码设置

    2.1.3 修改注解设置

    2.1.4 确保java编译版本为8

    2.1.5 POM设置

    2.1.6 maven设置

    2.2 创建微服务提供者支付模块

    2.2.1 创建maven子工程

    2.2.2 改POM

    2.2.3 创建YML

    2.2.4 主启动类

    2.2.5 业务类

    2.2.6 测试

    2.3 创建微服务消费者订单模块

    2.3.1 创建maven子工程

    2.3.2 改POM

    2.3.3 写YML

    2.3.4 主启动类

    2.3.5 业务类

    2.3.6 测试

    2.4 重构项目-公共类的抽取

    2.4.1 新建一个maven项目

    2.4.2 改POM

    2.4.3 entities

    2.4.4 执行maven命令-clean、install

    2.4.5 Order、Payment模块的简化

    一、微服务架构总览

             上面是几年前的微服务常用的组件，最近几年springcloudAlibaba正逐渐成为主流。下面列出了最近较流行的微服务架构，其亮点是新增加了若干Alibaba的微服务组件，如nacos、sentinel。

    二、创建Rest风格的微服务工程

    2.1 创建微服务父工程

    2.1.1 使用maven新建父工程

    2.1.2 字符编码设置

    2.1.3 修改注解设置

    2.1.4 确保java编译版本为8

    2.1.5 POM设置

            这里有些参数会报错，不用理会。

    1.   <groupId>com.atguigu.springcloudgroupId>
    2.     <artifactId>mscloud03artifactId>
    3.     <version>1.0-SNAPSHOTversion>
    4.     
    5.     <packaging>pompackaging>
    6.  
    7.     
    8.     <properties>
    9.         <project.build.sourceEncoding>UTF-8project.build.sourceEncoding>
    10.         <maven.compiler.source>8maven.compiler.source>
    11.         <maven.compiler.target>8maven.compiler.target>
    12.         <junit.version>4.12junit.version>
    13.         <lombok.version>1.18.10lombok.version>
    14.         <log4j.version>1.2.17log4j.version>
    15.         <mysql.version>5.1.47mysql.version>
    16.         <druid.version>1.1.16druid.version>
    17.         <mybatis.spring.boot.version>1.3.0mybatis.spring.boot.version>
    18.     properties>
    19.  
    20.     
    21.     <dependencyManagement>
    22.         <dependencies>
    23.             
    24.             <dependency>
    25.                 <groupId>org.springframework.bootgroupId>
    26.                 <artifactId>spring-boot-dependenciesartifactId>
    27.                 <version>2.2.2.RELEASEversion>
    28.                 <type>pomtype>
    29.                 <scope>importscope>
    30.             dependency>
    31.             
    32.             <dependency>
    33.                 <groupId>org.springframework.cloudgroupId>
    34.                 <artifactId>spring-cloud-dependenciesartifactId>
    35.                 <version>Hoxton.SR1version>
    36.                 <type>pomtype>
    37.                 <scope>importscope>
    38.             dependency>
    39.             
    40.             <dependency>
    41.                 <groupId>com.alibaba.cloudgroupId>
    42.                 <artifactId>spring-cloud-alibaba-dependenciesartifactId>
    43.                 <version>2.1.0.RELEASEversion>
    44.                 <type>pomtype>
    45.                 <scope>importscope>
    46.             dependency>
    47.             <dependency>
    48.                 <groupId>mysqlgroupId>
    49.                 <artifactId>mysql-connector-javaartifactId>
    50.                 <version>${mysql.version}version>
    51.             dependency>
    52.             <dependency>
    53.                 <groupId>com.alibabagroupId>
    54.                 <artifactId>druidartifactId>
    55.                 <version>${druid.version}version>
    56.             dependency>
    57.             <dependency>
    58.                 <groupId>org.mybatis.spring.bootgroupId>
    59.                 <artifactId>mybatis-spring-boot-starterartifactId>
    60.                 <version>${mybatis.spring.boot.version}version>
    61.             dependency>
    62.             <dependency>
    63.                 <groupId>junitgroupId>
    64.                 <artifactId>junitartifactId>
    65.                 <version>${junit.version}version>
    66.             dependency>
    67.             <dependency>
    68.                 <groupId>log4jgroupId>
    69.                 <artifactId>log4jartifactId>
    70.                 <version>${log4j.version}version>
    71.             dependency>
    72.             <dependency>
    73.                 <groupId>org.projectlombokgroupId>
    74.                 <artifactId>lombokartifactId>
    75.                 <version>${lombok.version}version>
    76.                 <optional>trueoptional>
    77.             dependency>
    78.         dependencies>
    79.     dependencyManagement>
    80.  
    81.     <build>
    82.         <plugins>
    83.             <plugin>
    84.                 <groupId>org.springframework.bootgroupId>
    85.                 <artifactId>spring-boot-maven-pluginartifactId>
    86.                 <version>2.5.12version>
    87.                 <configuration>
    88.                     <fork>truefork>
    89.                     <addResources>trueaddResources>
    90.                 configuration>
    91.             plugin>
    92.         plugins>
    93.     build>

    2.1.6 maven设置

            关闭 test 操作

            最后执行 install 操作，将父工程发布到仓库方便子工程继承

    2.2 创建微服务提供者支付模块

    2.2.1 创建maven子工程

           在父工程的基础上创建一个maven子工程，名字：cloud-provider-payment8001

    2.2.2 改POM

    1.  
    2.     <dependencies>
    3.         <dependency>
    4.             <groupId>org.springframework.bootgroupId>
    5.             <artifactId>spring-boot-starter-webartifactId>
    6.         dependency>
    7.         <dependency>
    8.             <groupId>org.springframework.bootgroupId>
    9.             <artifactId>spring-boot-starter-actuatorartifactId>
    10.         dependency>
    11.         <dependency>
    12.             <groupId>org.mybatis.spring.bootgroupId>
    13.             <artifactId>mybatis-spring-boot-starterartifactId>
    14.         dependency>
    15.         <dependency>
    16.             <groupId>com.alibabagroupId>
    17.             <artifactId>druid-spring-boot-starterartifactId>
    18.             <version>1.1.10version>
    19.         dependency>
    20.         
    21.         <dependency>
    22.             <groupId>mysqlgroupId>
    23.             <artifactId>mysql-connector-javaartifactId>
    24.         dependency>
    25.         
    26.         <dependency>
    27.             <groupId>org.springframework.bootgroupId>
    28.             <artifactId>spring-boot-starter-jdbcartifactId>
    29.         dependency>
    30.         <dependency>
    31.             <groupId>org.springframework.bootgroupId>
    32.             <artifactId>spring-boot-devtoolsartifactId>
    33.             <scope>runtimescope>
    34.             <optional>trueoptional>
    35.         dependency>
    36.         <dependency>
    37.             <groupId>org.projectlombokgroupId>
    38.             <artifactId>lombokartifactId>
    39.             <optional>trueoptional>
    40.         dependency>
    41.         <dependency>
    42.             <groupId>org.springframework.bootgroupId>
    43.             <artifactId>spring-boot-starter-testartifactId>
    44.             <scope>testscope>
    45.         dependency>
    46.     dependencies>

    2.2.3 创建YML

            注意修改数据库名字、用户名、密码

    1. # 端口号
    2. server:
    3.   port: 8001
    4.  
    5. spring:
    6.   application:
    7.     name: cloud-payment-service
    8.   datasource:
    9.     type: com.alibaba.druid.pool.DruidDataSource            # 当前数据源操作类型
    10.     driver-class-name: org.gjt.mm.mysql.Driver              # mysql驱动
    11.     url: jdbc:mysql://localhost:3306/db2019?useUnicode=true&characterEncoding=utf-8&useSSL=false
    12.     username: root
    13.     password: 123456
    14.  
    15.  
    16. mybatis:
    17.   mapperLocations: classpath:mapper/*.xml
    18.   type-aliases-package: com.atguigu.springcloud.entities    # 所有Entity别名类所在包
    19.

    2.2.4 主启动类

    1. @SpringBootApplication
    2. public class PaymentMain8001
    3. {
    4.     public static void main(String[] args)
    5.     {
    6.         SpringApplication.run(PaymentMain8001.class,args);
    7.     }
    8. }

            注意：我的idea默认不会识别出springboot的配置和配置文件。自定义主启动类时类名上会有波浪线提示，按照提示在工程中添加Spring的module即可。

    2.2.5 业务类

            1. SQL表

    1. CREATE TABLE `payment` (
    2.   `id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT 'ID',
    3.   `serial` varchar(200) DEFAULT '',
    4.   PRIMARY KEY (`id`)
    5. ) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8

            2.entities

    1. @Data
    2. @AllArgsConstructor
    3. @NoArgsConstructor
    4. public class Payment implements Serializable
    5. {
    6.     private Long id;
    7.     private String serial;
    8. }
    1. @Data
    2. @AllArgsConstructor
    3. @NoArgsConstructor
    4. public class CommonResult
    5. {
    6.     private Integer code;
    7.     private String  message;
    8.     private T data;
    9.  
    10.     public CommonResult(Integer code, String message)
    11.     {
    12.         this(code,message,null);
    13.     }
    14. }

            Payment是订单实体类，CommonResult是用于统一响应请求的。

            3. mapper接口

    1. @Mapper  //import org.apache.ibatis.annotations.Mapper;
    2. public interface PaymentDao
    3. {
    4.     public int create(Payment payment);
    5.  
    6.     public Payment getPaymentById(@Param("id") Long id);
    7. }

            4. mapper映射文件

    1. "1.0" encoding="UTF-8" ?>
    2. mapper
    3.         PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
    4.         "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
    5. <mapper namespace="com.atguigu.springcloud.dao.PaymentDao">
    6.     
    7.     <insert id="create" parameterType="com.atguigu.springcloud.entities.Payment" useGeneratedKeys="true" keyProperty="id">
    8.     
    9.     insert into payment(serial) values (#{serial});
    10.     insert>
    11.  
    12.     
    13.     <select id="getPaymentById" parameterType="Long" resultMap="BaseResultMap">
    14.         select *from payment where id=#{id}
    15.     select>
    16.  
    17.     
    18.     <resultMap id="BaseResultMap" type="com.atguigu.springcloud.entities.Payment">
    19.         <id column="id" property="id" jdbcType="BIGINT"/>
    20.         <result column="serial" property="serial" jdbcType="VARCHAR"/>
    21.     resultMap>
    22. mapper>

            5. Service接口与实现类

    1. public interface PaymentService {
    2.     int create(Payment payment);
    3.     Payment getPaymentById(@Param("id") Long id);
    4. }
    1. @Service
    2. public class PaymentServiceImpl implements PaymentService {
    3.     @Autowired
    4.     private PaymentDao paymentDao;
    5.     @Override
    6.     public int create(Payment payment) {
    7.         return paymentDao.create(payment);
    8.     }
    9.  
    10.     @Override
    11.     public Payment getPaymentById(Long id) {
    12.         return paymentDao.getPaymentById(id);
    13.     }
    14. }

            6. controller

    1. @RestController
    2. @Slf4j
    3. public class PaymentController
    4. {
    5.     @Resource
    6.     private PaymentService paymentService;
    7.  
    8.     @PostMapping(value = "/payment/create")
    9.     //一定要使用@RequestBody注解，否则插入的数据异常
    10.     public CommonResult create(@RequestBody Payment payment)
    11.     {
    12.         int result = paymentService.create(payment);
    13.         log.info("*****插入操作返回结果:" + result);
    14.  
    15.         if(result > 0)
    16.         {
    17.             return new CommonResult(200,"插入数据库成功",result);
    18.         }else{
    19.             return new CommonResult(444,"插入数据库失败",null);
    20.         }
    21.     }
    22.  
    23.     @GetMapping(value = "/payment/get/{id}")
    24.     public CommonResult getPaymentById(@PathVariable("id") Long id)
    25.     {
    26.         Payment payment = paymentService.getPaymentById(id);
    27.         log.info("*****查询结果:{}",payment);
    28.         if (payment != null) {
    29.             return new CommonResult(200,"查询成功",payment);
    30.         }else{
    31.             return new CommonResult(444,"没有对应记录,查询ID: "+id,null);
    32.         }
    33.     }
    34. }

    2.2.6 测试

    1. 输入：http://localhost:8001/payment/get/31
    2.  
    3. 响应：
    4. {
    5.     "code": 200,
    6.     "message": "查询成功！",
    7.     "data": {
    8.         "id": 31,
    9.         "serial": "wzwzwz"
    10.     }
    11. }

            对于Post请求，可以使用PostMan软件实现请求的发送。

    2.3 创建微服务消费者订单模块

    2.3.1 创建maven子工程

            在父工程下建子工程，名字：cloud-consumer-order80

    2.3.2 改POM

    1.     <dependencies>
    2.         <dependency>
    3.             <groupId>org.springframework.bootgroupId>
    4.             <artifactId>spring-boot-starter-webartifactId>
    5.         dependency>
    6.         <dependency>
    7.             <groupId>org.springframework.bootgroupId>
    8.             <artifactId>spring-boot-starter-actuatorartifactId>
    9.         dependency>
    10.  
    11.         <dependency>
    12.             <groupId>org.springframework.bootgroupId>
    13.             <artifactId>spring-boot-devtoolsartifactId>
    14.             <scope>runtimescope>
    15.             <optional>trueoptional>
    16.         dependency>
    17.         <dependency>
    18.             <groupId>org.projectlombokgroupId>
    19.             <artifactId>lombokartifactId>
    20.             <optional>trueoptional>
    21.         dependency>
    22.         <dependency>
    23.             <groupId>org.springframework.bootgroupId>
    24.             <artifactId>spring-boot-starter-testartifactId>
    25.             <scope>testscope>
    26.         dependency>
    27.     dependencies>

    2.3.3 写YML

    1. #指定端口
    2. server:
    3.   port: 80
    4.  
    5. spring:
    6.   application:
    7.     name: cloud-order-service

    2.3.4 主启动类

    1. @SpringBootApplication
    2. public class MainApp80
    3. {
    4.     public static void main(String[] args)
    5.     {
    6.         SpringApplication.run(MainApp80.class,args);
    7.     }
    8. }

    2.3.5 业务类

            1. entities

    1. @Data
    2. @AllArgsConstructor
    3. @NoArgsConstructor
    4. public class Payment implements Serializable
    5. {
    6.     private Long id;
    7.     private String serial;
    8. }
    1. @Data
    2. @AllArgsConstructor
    3. @NoArgsConstructor
    4. public class CommonResult {
    5.     private Integer code;
    6.     private String message;
    7.     private T data;
    8.  
    9.     public CommonResult(Integer code, String message) {
    10.         this.code = code;
    11.         this.message = message;
    12.         this.data = null;
    13.     }
    14. }

             2.配置类（RestTemplate）

            RestTemplate提供了多种便捷访问远程Http服务的方法， 是一种简单便捷的访问restful服务模板类，是Spring提供的用于访问Rest服务的客户端模板工具集

            使用：
            (url ,  requestMap ,  ResponseBean.class)

    这三个参数分别代表 REST请求地址、请求参数、HTTP响应被转换成的对象类型。

    1. @Configuration
    2. public class ApplicationContextConfig {
    3.     @Bean
    4.     @LoadBalanced
    5.     public RestTemplate getRestTemplate(){return new RestTemplate();}
    6. }

            3. controller

    1. @RestController
    2. public class OrderController
    3. {
    4.  
    5.     public static final String PaymentSrv_URL = "http://localhost:8001";
    6.  
    7.     @Autowired
    8.     private RestTemplate restTemplate;
    9.  
    10.     @GetMapping("/consumer/payment/create") //客户端用浏览器是get请求，但是底层实质发送post调用服务端8001
    11.     public CommonResult create(Payment payment)
    12.     {
    13.         return restTemplate.postForObject(PaymentSrv_URL + "/payment/create",payment,CommonResult.class);
    14.     }
    15.  
    16.  
    17.     @GetMapping("/consumer/payment/get/{id}")
    18.     public CommonResult getPayment(@PathVariable Long id)
    19.     {
    20.         return restTemplate.getForObject(PaymentSrv_URL + "/payment/get/"+id, CommonResult.class, id);
    21.     }
    22. }

    2.3.6 测试

    1. 输入： http://localhost/consumer/payment/get/31
    2.  
    3. 响应：
    4. {
    5.     "code": 200,
    6.     "message": "查询成功！",
    7.     "data": {
    8.         "id": 31,
    9.         "serial": "wzwzwz"
    10.     }
    11. }

            实际上相当于Order模块将请求转发给了Payment模块，对数据库进行操作，然后Payment模块将查询结果以JSON的形式返回给Order模块，响应给客户端。

    2.4 重构项目-公共类的抽取

            我们可以注意到，Order、Payment模块的实体类是完全相同的，为了减少冗余，我们可以将重复的类抽取出来作为公共类，同时供多个模块使用。

    2.4.1 新建一个maven项目

            名字为：cloud-api-commons

    2.4.2 改POM

    1.     <dependencies>
    2.         <dependency>
    3.             <groupId>org.springframework.bootgroupId>
    4.             <artifactId>spring-boot-devtoolsartifactId>
    5.             <scope>runtimescope>
    6.             <optional>trueoptional>
    7.         dependency>
    8.         <dependency>
    9.             <groupId>org.projectlombokgroupId>
    10.             <artifactId>lombokartifactId>
    11.             <optional>trueoptional>
    12.         dependency>
    13.         <dependency>
    14.             <groupId>cn.hutoolgroupId>
    15.             <artifactId>hutool-allartifactId>
    16.             <version>5.1.0version>
    17.         dependency>
    18.     dependencies>

    2.4.3 entities

    1. public class CommonResult
    2. {
    3.     private Integer code;
    4.     private String message;
    5.     private T data;
    6.  
    7.     public CommonResult()
    8.     {
    9.     }
    10.  
    11.     public CommonResult(Integer code, String message, T data)
    12.     {
    13.         this.code = code;
    14.         this.message = message;
    15.         this.data = data;
    16.     }
    17.     public CommonResult( Integer code,String message) {
    18.         this( code, message,null);
    19.     }
    20.  
    21.     public CommonResult(T data) {
    22.         this(200, "操作成功", data);
    23.     }
    24.  
    25.     //setter--getter
    26.     public T getData() {
    27.         return data;
    28.     }
    29.  
    30.     public void setData(T data) {
    31.         this.data = data;
    32.     }
    33.  
    34.     public String getMessage() {
    35.         return message;
    36.     }
    37.  
    38.     public void setMessage(String message) {
    39.         this.message = message;
    40.     }
    41.  
    42.     public Integer getCode() {
    43.         return code;
    44.     }
    45.  
    46.     public void setCode(Integer code) {
    47.         this.code = code;
    48.     }
    49. }
    1. @Data
    2. @AllArgsConstructor
    3. @NoArgsConstructor
    4. public class Payment implements Serializable
    5. {
    6.     private Long id;
    7.     private String serial;
    8. }

    2.4.4 执行maven命令-clean、install

            这样就可以将这个模块存到maven仓库，供其他模块引用了。

    2.4.5 Order、Payment模块的简化

            将entities包全部删掉，然后各自添加依赖

    1. <dependency>
    3.             <groupId>com.atguigu.springcloudgroupId>
    4.             <artifactId>cloud-api-commonsartifactId>
    5.             <version>${project.version}version>
    6. dependency>

            这样一来，我们建立了三个子模块，可以实现基本的业务。

            1. cloud-api-commons

            2. cloud-consumer-order80

            3. cloud-provider-payment8001

  • 相关阅读:
    安卓APP源码和设计报告——快递查询录入系统
    数据库设计：防止MySQL字段名与关键字相撞，保护数据完整性！
    grub 启动
    el-row一行放置3个el-col，有时出现空行现象
    数字化采购管理系统开发：精细化采购业务流程管理，赋能企业实现“阳光采购”
    Linux 命令【8】：ssm
    新零售SaaS架构：商品系统架构设计
    Excel函数公式大全—HLOOKUP函数
    C#winform软件实现一次编译，跨平台windows和linux兼容运行，兼容Visual Studio原生界面Form表单开发
    Arduino与Proteus仿真实例-简单信号频率计数仿真
  • 原文地址：https://blog.csdn.net/weixin_62427168/article/details/126440277