SpringCloud----环境搭建

2021-11-15 15:29:40 浏览数 (1)

SpringCloud

  • 父工程Project的相关配置
    • 父工程pom文件
    • DependencyManagement和Dependencies的区别
    • 跳过单元测试
  • 支付模块构建(上)
    • 创建微服务模块套路:
      • 在当前父工程下,创建cloud-provider-payment8001微服务提供者支付Module模块
      • 改pom
      • 写YML
      • 主启动
  • 支付模块构建(中)
    • 业务类
  • 支付模块构建(下)---总结
  • 热部署Devtools
    • 1.Adding devtools to your project
    • 2.Adding plugin to your pom.xml
    • 3.Enabling automatic build
    • 4.Update the value of
    • 5.重启IDEA
  • 消费者订单模块(上)
    • 1.建Module
    • 2.改POM
    • 3.写YML
    • 4.主启动
    • 5.业务类
    • 6.测试
    • RestTemplate
  • 消费者订单模块(下)
    • 问题
    • 打开Run Dashboard窗口
  • 工程重构
    • 1.新建 - cloud-api-commons,用来存放重复使用的部分
    • 2.POM--存放重复使用的依赖
    • 3.重复实体类
    • 4.将当前工程清理后,安装到本地仓库
    • 5.订单80和支付8001分别改造
    • 6.测试

父工程Project的相关配置

约定 > 配置 > 编码

创建微服务cloud整体聚合父工程Project,有8个关键步骤:

  1. New Project - maven工程 - create from archetype: maven-archetype-site
  2. 聚合总父工程名字
  3. Maven选版本
  4. 工程名字
  5. 字符编码 - Settings - File encoding
  6. 注解生效激活 - Settings - Annotation Processors
  7. Java编译版本选8
  8. File Type过滤 - Settings - File Type

父工程pom文件

代码语言:javascript复制
<?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>

<!--  聚合工程,打包方式为pom-->
  <groupId>com.dhy.springCloud</groupId>
  <artifactId>springCloud</artifactId>
  <version>1.0-SNAPSHOT</version>
  <packaging>pom</packaging>

<!--  父工程统一jar包版本管理-->
<!-- 自定义属性-->
  <properties>
      <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.18.20</lombok.version>
      <mysql.version>5.1.49</mysql.version>
      <druid.version>1.1.17</druid.version>
      <mybatis.spring.boot.version>2.1.4</mybatis.spring.boot.version>
  </properties>

    <!-- 子模块继承之后,提供作用:
           锁定版本 子modlue不用写groupId和version -->
<!--    ${}爆红,说明对应的版本在本地仓库中没有找到-->
    <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>

DependencyManagement和Dependencies的区别

Maven使用dependencyManagement元素来提供了一种管理依赖版本号的方式。

通常会在一个组织或者项目的最顶层的父POM中看到dependencyManagement元素。

使用pom.xml中的dependencyManagement元素能让所有在子项目中引用个依赖而不用显式的列出版本量。

Maven会沿着父子层次向上走,直到找到一个拥有dependencyManagement元素的项目,然后它就会使用这个 dependencyManagement元素中指定的版本号。

代码语言:javascript复制
<dependencyManagement>
    <dependencies>
        <dependency>
        <groupId>mysq1</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>5.1.2</version>
        </dependency>
    <dependencies>
</dependencyManagement>

然后在子项目里就可以添加mysql-connector时可以不指定版本号,例如:

代码语言:javascript复制
<dependencies>
    <dependency>
    <groupId>mysq1</groupId>
    <artifactId>mysql-connector-java</artifactId>
    </dependency>
</dependencies>

这样做的好处就是:如果有多个子项目都引用同一样依赖,则可以避免在每个使用的子项目里都声明一个版本号,这样当想升级或切换到另一个版本时,只需要在顶层父容器里更新,而不需要一个一个子项目的修改;另外如果某个子项目需要另外的一个版本,只需要声明version就可。

  • dependencyManagement里只是声明依赖,并不实现引入,因此子项目需要显示的声明需要用的依赖。
  • 如果不在子项目中声明依赖,是不会从父项目中继承下来的;只有在子项目中写了该依赖项,并且没有指定具体版本,才会从父项目中继承该项,并且versionscope都读取自父pom
  • 如果子项目中指定了版本号,那么会使用子项目中指定的jar版本。

跳过单元测试

IDEA右侧旁的Maven插件有ToggleSkip Tests' Mode按钮,这样maven可以跳过单元测试

父工程创建完成执行mvn : install将父工程发布到仓库方便子工程继承。


支付模块构建(上)

创建微服务模块套路:

  • 建Module
  • 改POM
  • 写YML
  • 主启动
  • 业务类

在当前父工程下,创建cloud-provider-payment8001微服务提供者支付Module模块


改pom

代码语言:javascript复制
<?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.dhy.springCloud</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>

    <modelVersion>4.0.0</modelVersion>

<!--    继承父类的版本号和组织名-->
    <artifactId>cloud-provider-payment8001</artifactId>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
<!--        springboot指标监控模块-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid-spring-boot-starter</artifactId>
            <version>1.1.10</version>
        </dependency>
        <!--mysql-connector-java-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
        <!--jdbc-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jdbc</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-autoconfigure</artifactId>
        </dependency>
    </dependencies>

</project>

写YML

代码语言:javascript复制
server:
  port: 8001

spring:
  application:
    name: cloud-payment-service
  datasource:
    type: com.alibaba.druid.pool.DruidDataSource            # 当前数据源操作类型
    driver-class-name: org.gjt.mm.mysql.Driver              # mysql驱动包
    url: jdbc:mysql://localhost:3306/test1?useUnicode=true&characterEncoding=utf-8&useSSL=false
    username: root
    password: 126433

mybatis:
  mapperLocations: classpath:mapper/*.xml #映射文件的位置
  type-aliases-package: com.dhy.pojo    #给当前包下的所有类起一个别名,默认是类名小写

主启动

代码语言:javascript复制
@SpringBootApplication
public class PaymentMain001
{
    public static void main(String[] args) {
        SpringApplication.run(PaymentMain001.class, args);
    }
}

支付模块构建(中)

业务类

创建表:

代码语言:javascript复制
CREATE TABLE `payment`(
	`id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT 'ID',
    `serial` varchar(200) DEFAULT '',
	PRIMARY KEY (id)
)ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8mb4

实体类Payment:

代码语言:javascript复制
@Data
@AllArgsConstructor
@NoArgsConstructor
public class Payment implements Serializable {
    private Long id;
    private String serial;
}

JSON封装体CommonResult,作用通用返回格式,返回给前端

代码语言:javascript复制
@Data
@AllArgsConstructor
@NoArgsConstructor
public class CommonResult<T>{
    private Integer code;
    private String message;
    private T data;

    public CommonResult(Integer code, String message){
        this(code, message, null);
    }
}

接口PaymentDao:

代码语言:javascript复制
@Mapper
//@Repository不用Spring的
public interface PaymentDao
{
    public int create(Payment payment);
    
    public Payment getPaymentById(@Param("id") Long id);
}

MyBatis映射文件PaymentMapper.xml

代码语言:javascript复制
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd" >

<mapper namespace="com.dhy.Dao.PaymentDao">

<!--    获取自增主键的值-->
    <insert id="create" parameterType="payment" useGeneratedKeys="true" keyProperty="id">
        insert into payment(serial)  values(#{serial});
    </insert>

<!--属性名和列名的映射关系,并且指定当前属性名对应数据库列名的数据类型-->
    <resultMap id="BaseResultMap" type="payment">
        <id column="id" property="id" jdbcType="BIGINT"/>
        <id column="serial" property="serial" jdbcType="VARCHAR"/>
    </resultMap>

<!--    查询出来的结果,使用上面的映射关系自动封装为对应的对象-->
    <select id="getPaymentById" parameterType="Long" resultMap="BaseResultMap">
        select * from payment where id=#{id};
    </select>

</mapper>

接口PaymentService

代码语言:javascript复制
public interface PaymentService
{
    public int create(Payment payment);

    public Payment getPaymentById(Long id);
}

实现类

代码语言:javascript复制
@Service
public class PaymentServiceImpl implements PaymentService
{
    @Resource
    private PaymentDao paymentDao;

    public int create(Payment payment)
    {
        return paymentDao.create(payment);
    }

    public Payment getPaymentById(Long id)
    {
        return paymentDao.getPaymentById(id);
    }
}

controller

代码语言:javascript复制
@RestController
@Slf4j
public class PaymentController{
    @Resource
    private PaymentService paymentService;

    @PostMapping(value = "/payment/create")
    public CommonResult create(Payment payment)
    {
        int result = paymentService.create(payment);
        log.info("*****插入结果:" result);

        if(result > 0)
        {
            return new CommonResult(200,"插入数据库成功",result);
        }else{
            return new CommonResult(444,"插入数据库失败",null);
        }
    }

    @GetMapping(value = "/payment/get/{id}")
    public CommonResult<Payment> getPaymentById(@PathVariable("id") Long id)
    {
        Payment payment = paymentService.getPaymentById(id);

        if(payment != null)
        {
            return new CommonResult(200,"查询成功",payment);
        }else{
            return new CommonResult(444,"没有对应记录,查询ID: " id,null);
        }
    }
}

支付模块构建(下)—总结

创建微服务模块套路:

  • 建Module
  • 改POM
  • 写YML
  • 主启动
  • 业务类

热部署Devtools

开发时使用,生产环境关闭

1.Adding devtools to your project

放到子工程,而非父工程,这里放到我们端口号为8001的子工程里面

代码语言:javascript复制
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-devtools</artifactId>
    <scope>runtime</scope>
    <optional>true</optional>
</dependency>

2.Adding plugin to your pom.xml

添加插件到父工程,将Spring Boot应用打包为可执行的jar或war文件,执行springboot应用

下段配置复制到聚合父类总工程的pom.xml

代码语言:javascript复制
<build>
    <!--
	<finalName>你的工程名</finalName>(单一工程时添加)
    -->
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
            <configuration>
                <fork>true</fork>
                <addResources>true</addResources>
            </configuration>
        </plugin>
    </plugins>
</build>

3.Enabling automatic build

File -> Settings(New Project Settings->Settings for New Projects) ->Complier

4.Update the value of

键入Ctrl Shift Alt / ,打开Registry,勾选:

compiler.automake.allow.when.app.running

actionSystem.assertFocusAccessFromEdt

5.重启IDEA


消费者订单模块(上)

1.建Module

创建名为cloud-consumer-order80的maven工程。


2.改POM

代码语言:javascript复制
<?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.dhy.springCloud</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>cloud-consumer-order80</artifactId>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>

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

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>
    
</project>

3.写YML

代码语言:javascript复制
server:
  port: 80

4.主启动

代码语言:javascript复制
@SpringBootApplication
public class OrderMain
{
    public static void main(String[] args)
    {
        SpringApplication.run(OrderMain.class,args);
    }
}

5.业务类

实体类:

代码语言:javascript复制
@Data
@AllArgsConstructor
@NoArgsConstructor
public class Payment implements Serializable {
    private Long id;
    private String serial;
}
代码语言:javascript复制
@Data
@AllArgsConstructor
@NoArgsConstructor
public class CommonResult<T>{
    private Integer code;
    private String message;
    private T data;

    public CommonResult(Integer code, String message){
        this(code, message, null);
    }
}

控制层:

代码语言:javascript复制
@Slf4j
@RestController
public class OrderController
{
    public static final String PAYMENT_URL = "http://localhost:8001";

    @Resource//负责完成远程接口调用,封装了httpClient
    private RestTemplate restTemplate;

    @GetMapping("/consumer/payment/create")
    public CommonResult<Payment> create(Payment payment){

        return restTemplate.postForObject(PAYMENT_URL "/payment/create", payment, CommonResult.class);
    }

    @GetMapping("/consumer/payment/get/{id}")
    public CommonResult<Payment> getPayment(@PathVariable("id") Long id){
        return restTemplate.getForObject(PAYMENT_URL "/payment/get/" id, CommonResult.class);
    }
}

配置类:

代码语言:javascript复制
@Configuration
public class ApplicationContextConfig
{
//将restTemplate注册到容器中
    @Bean
    public RestTemplate getRestTemplate()
    {
        return new RestTemplate();
    }
}

6.测试

运行cloud-consumer-order80与cloud-provider-payment8001两工程

  • 浏览器 - http://localhost/consumer/payment/get/1

RestTemplate

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

使用:

  • 使用restTemplate访问restful接口非常的简单粗暴无脑。
  • (url, requestMap, ResponseBean.class)这三个参数分别代表。
  • REST请求地址、请求参数、HTTP响应转换被转换成的对象类型。

消费者订单模块(下)

问题


打开Run Dashboard窗口

当springcloud的服务有多个时,管理多个服务的启动使用run会不好管理,这样我们就可以使用Run Dashboard。

通过修改idea的workspace.xml的方式来快速打开Run Dashboard窗口。

  • 开启Run DashBoard

打开工程路径下的.idea文件夹的workspace.xml

在< component name=“RunDashboard” >中修改或添加以下代码:

代码语言:javascript复制
<component name="RunDashboard"> 
	<option name="configurationTypes">
	 	<set> 
	 		<option value="SpringBootApplicationConfigurationType" />
	 	</set> 
 	</option> 
 	<option name="ruleStates"> 
 		<list> 
 			<RuleState> 
 				<option name="name" value="ConfigurationTypeDashboardGroupingRule" /> 
 			</RuleState> 
 			<RuleState> 
 				<option name="name" value="StatusDashboardGroupingRule" /> 
 			</RuleState> 
 		</list>
 	</option> 
</component>

工程重构

cloud-consumer-order80与cloud-provider-payment8001两工程有重复代码(entities包下的实体),需要将重复的部分抽离出去

1.新建 - cloud-api-commons,用来存放重复使用的部分

2.POM–存放重复使用的依赖

代码语言:javascript复制
<?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.dhy.springCloud</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>cloud-api-commons</artifactId>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>cn.hutool</groupId>
            <artifactId>hutool-all</artifactId>
            <version>5.1.0</version>
        </dependency>
    </dependencies>

</project>

3.重复实体类

将cloud-consumer-order80与cloud-provider-payment8001两工程的公有entities包移至cloud-api-commons工程下。

4.将当前工程清理后,安装到本地仓库

maven clean、install cloud-api-commons工程,以供给cloud-consumer-order80与cloud-provider-payment8001两工程调用。

5.订单80和支付8001分别改造

  • 将cloud-consumer-order80与cloud-provider-payment8001两工程的公有entities包移除
  • 引入cloud-api-commons依赖
代码语言:javascript复制
        <dependency>
            <groupId>com.dhy.springCloud</groupId>
            <artifactId>cloud-api-commons</artifactId>
            <version>${project.version}</version>
        </dependency>

在8001工程中:

6.测试


0 人点赞