SpringCloud-1-父工程的建立以及RestFul风格实现provider和consumer

SpringCloud----父工程的建立以及RestFul风格实现provider和consumer

目录

• SpringCloud----父工程的建立以及RestFul风格实现provider和consumer
  • 1.父工程依赖
  • 2. Rest
    • 1. 服务拆分
    • 2. 建立数据库
    • 3. SpringCloud-API
      • 1. 导入依赖
      • 2. 编写实体类
    • 4. SpringCloud-provider-dept-8001
      • 1. 导入依赖
      • 2. SpringBoot及Mybatis配置
        • 1. SpringBoot配置
        • 2. Mybatis配置
      • 3. Dao以及Service层
        • 1. Dao
        • 2. Service
          • 1. Service接口
          • 2. Service实现类
      • 4. Controller层
      • 5. Mapper
      • 6. 编写SpringBoot的启动类
    • 5. SpringCloud-consumer-dept-8080
      • 1. 配置端口
      • 2. 注册RestTemplate
      • 3. 编写Controller
      • 4. 编写主启动类
      • 5. 测试

1.父工程依赖

编写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">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.wang</groupId>
    <artifactId>SpringCloud</artifactId>
    <version>1.0-SNAPSHOT</version>
    <modules>
        <module>SpringCloud-API</module>
        <module>SpringCloud-provider-dept-8001</module>
    </modules>

    <!--打包方式 pom-->
    <packaging>pom</packaging>

    <!--在这里管理版本号, 方便以后修改-->
    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <maven.compiler.source>14</maven.compiler.source>
        <maven.complier.target>14</maven.complier.target>
        <junit.version>4.12</junit.version>
        <lombok.version>1.18.12</lombok.version>
        <log4j.version>1.2.17</log4j.version>
    </properties>

    <!--dependencyManagement是个管理, 不会导入库-->
    <dependencyManagement>
        <dependencies>
            <!--SpringCloud的依赖-->
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>Greenwich.SR1</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <!--SpringBoot的依赖-->
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>2.2.5.RELEASE</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <!--数据库-->
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <version>5.1.47</version>
            </dependency>
            <!--Druid-->
            <dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>druid</artifactId>
                <version>1.1.10</version>
            </dependency>
            <!--SpringBoot-Mybatis 启动器-->
            <dependency>
                <groupId>org.mybatis.spring.boot</groupId>
                <artifactId>mybatis-spring-boot-starter</artifactId>
                <version>1.3.2</version>
            </dependency>
            <!--junit-->
            <dependency>
                <groupId>junit</groupId>
                <artifactId>junit</artifactId>
                <version>${junit.version}</version>
            </dependency>
            <!--lombok-->
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <version>${lombok.version}</version>
            </dependency>
            <!--log4j-->
            <dependency>
                <groupId>log4j</groupId>
                <artifactId>log4j</artifactId>
                <version>${log4j.version}</version>
            </dependency>
            <!--日志-->
            <dependency>
                <groupId>ch.qos.logback</groupId>
                <artifactId>logback-core</artifactId>
                <version>1.2.3</version>
            </dependency>
        </dependencies>
    </dependencyManagement>

</project>

这里有以下几点要注意

• 可以在properties标签中管理版本号以及编译器使用的JDK版本
• 在dependencyManagement标签中管理项目中要使用的全部依赖, 这里不会导入lib
• 在dependency标签中使用${XXX}引用properties管理的版本号
• SpringBoot的版本以及Lombok的版本要注意是否与当前JDK匹配, 高版本的JDK要使用高版本的依赖,否则无法编译(Lombok则无法打包到Maven)

2. Rest

编写Restful风格的API接口

1. 服务拆分

• 在API项目中写实体类

• 在provider中写提供者的具体实现

2. 建立数据库

在微服务中, 个服务对应一个数据库, 同一个数据可能存在不同的数据库, 因此我们需要一个字段来表明该数据库是哪一个, 这里使用db_source字段

3. SpringCloud-API

1. 导入依赖

<?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.wang</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>SpringCloud-API</artifactId>

    <!--当前的Module自己需要的依赖, 如果父依赖中已经配置了版本, 这里就不用写了-->
    <dependencies>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
    </dependencies>


</project>

注意

• 在父项目中只是管理了依赖, 在这里导入依赖才会导包
• 此处的依赖的版本号在父项目中管理, 不需要写, 也不建议写, 以防出现版本冲突

2. 编写实体类

package com.wang.springcloud.pojo;

import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.experimental.Accessors;

import java.io.Serializable;

@Data
@NoArgsConstructor
//支持链式写法
@Accessors(chain = true)
public class Dept implements Serializable {

    private Long deptno;
    private String dname;
    //这个数据存在哪个数据库的字段 ==> 微服务, 一个服务对应一个数据库, 同一个数据可能存在不同的数据库
    private String db_source;

    public Dept(String dname) {
        this.dname = dname;
    }
}

4. SpringCloud-provider-dept-8001

这里命名规范最好写上端口号

1. 导入依赖

<?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.wang</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>SpringCloud-provider-dept-8001</artifactId>

    <dependencies>
        <!--我们需要拿到实体类, 所以要配置api module-->
        <dependency>
            <groupId>com.wang</groupId>
            <artifactId>SpringCloud-API</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
        </dependency>
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-core</artifactId>
        </dependency>
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
        </dependency>
        <!--test-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-test</artifactId>
        </dependency>
        <!--web-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!--jetty-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jetty</artifactId>
        </dependency>
        <!--热部署工具-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
        </dependency>
    </dependencies>

</project>

注意

• 这里由于进行了服务的拆分, 同时在父项目中指定了使用pom方式打包, 这里想要使用API中的实体类, 需要导入依赖

2. SpringBoot及Mybatis配置

1. SpringBoot配置

server:
  port: 8001

#mybatis配置
mybatis:
  type-aliases-package: com.wang.springcloud.pojo
  mapper-locations: classpath:mybatis/mapper/*.xml
  config-location: classpath:mybatis/mybatis-config.xml

#Spring的配置
spring:
  application:
    name: springcloud-provider-dept
  #数据源
  datasource:
    type: com.alibaba.druid.pool.DruidDataSource
    driver-class-name: org.gjt.mm.mysql.Driver
    url: jdbc:mysql://localhost:3306/db01?useUnicode=true&characterEncoding=utf-8
    username: root
    password: 123456

注意

• mybatis的config-location指定的是mybatis的配置文件的路径, mapper-locations指定的是mapper的路径, 他们都在resources目录下
• 使用其他数据连接池, 要指定名字

2. Mybatis配置

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
    <settings>
        <!--开启二级缓存-->
        <setting name="cacheEnabled" value="true"/>
    </settings>

</configuration>

3. Dao以及Service层

1. Dao

package com.wang.springcloud.dao;

import com.wang.springcloud.pojo.Dept;
import org.apache.ibatis.annotations.Mapper;
import org.springframework.stereotype.Repository;

import java.util.List;

@Mapper
@Repository
public interface DeptDao {

    boolean addDept(Dept dept);

    Dept queryById(Long deptno);

    List<Dept> queryAll();
}

注意

• 这里要写@Mapper和Mybatis绑定

• Dao层使用@Repository被SpringBoot接管接口

2. Service

1. Service接口

package com.wang.springcloud.service;

import com.wang.springcloud.pojo.Dept;

import java.util.List;

public interface DeptService {

    boolean addDept(Dept dept);

    Dept queryById(Long deptno);

    List<Dept> queryAll();
}

2. Service实现类

package com.wang.springcloud.service;

import com.wang.springcloud.dao.DeptDao;
import com.wang.springcloud.pojo.Dept;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.util.List;

@Service
public class DeptServiceImpl implements DeptService {

    @Autowired
    private DeptDao deptDao;

    @Override
    public boolean addDept(Dept dept) {
        return deptDao.addDept(dept);
    }

    @Override
    public Dept queryById(Long deptno) {
        return deptDao.queryById(deptno);
    }

    @Override
    public List<Dept> queryAll() {
        return deptDao.queryAll();
    }
}

注意

• 这里要使用自动装配将Dao层的结果通过Service层传递到返回值中实现调用(实际上是执行Dao层对SQL的调用, 这里方便以后扩展功能)
• Service层的SpringBoot托管注解为@Service

4. Controller层

package com.wang.springcloud.controller;

import com.wang.springcloud.pojo.Dept;
import com.wang.springcloud.service.DeptService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.List;

//提供RestFul服务!
@RestController
public class DeptController {

    @Autowired
    private DeptService deptService;

    @PostMapping("/dept/add")
    public boolean addDept(@RequestBody Dept dept){
        return deptService.addDept(dept);
    }

    @GetMapping("/dept/get/{id}")
    public Dept get(@PathVariable("id") Long id){
        return deptService.queryById(id);
    }

    @GetMapping("/dept/list")
    public List<Dept> queryAll(){
        return deptService.queryAll();
    }
}

注意

• 由于我们这里是提供接口调用, 因此使用@RestController注解
• 使用RestFul风格传参, 需要配合@PathVariable注解
• 提交数据使用Post请求, 提高安全性
• 这里需要自动装配Service接口, 此处由于只有一个实现类, 可以直接装配; 如果有多个实现类的话, 需要配合@Qualified注解指定实现类的名字

5. Mapper

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.wang.springcloud.dao.DeptDao">
    <insert id="addDept" parameterType="Dept">
        insert into db01.dept (dname, db_source)
        values (#{dname}, DATABASE());
    </insert>

    <select id="queryById" resultType="Dept" parameterType="Long">
        select * from db01.dept where deptno = #{deptno};
    </select>

    <select id="queryAll" resultType="Dept">
        select * from db01.dept;
    </select>
</mapper>

注意

• 改造Mybatis的Config为Mapper, 要替换DOCTYPE以及http中的config为mapper
• mapper标签中不要忘了写命名空间和Dao层绑定

6. 编写SpringBoot的启动类

package com.wang.springcloud;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

//启动类
@SpringBootApplication
public class DeptProvider_8001 {
    public static void main(String[] args) {
        SpringApplication.run(DeptProvider_8001.class, args);
    }
}

注意

• SpringBoot的启动类的写法如下
  • 添加@SpringBootApplication注解, 表明这是SpringBoot的主启动类
  • 在psvm中调用SpringApplication.run方法, 并将该启动类的class以及args作为参数

5. SpringCloud-consumer-dept-8080

1. 配置端口

server:
  port: 8080

2. 注册RestTemplate

package com.wang.springcloud.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.client.RestTemplate;

@Configuration
public class ConfigBean {

    //注册RestTemplate
    @Bean
    public RestTemplate getRestTemplate() {
        return new RestTemplate();
    }

}

3. 编写Controller

package com.wang.springcloud.controller;

import com.wang.springcloud.pojo.Dept;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestTemplate;

import java.util.List;

@RestController
public class DeptConsumerController {
    //消费者, 不应该有service层!(为了实现解耦)
    //RestFul模板 ==> RestTemplate, 里面有很多方法供我们直接调用, 需要注册到Spring中
    //远程调用provider的url

    //在ConfigBean中注册了, 这里可以直接自动装配(AutoWired是按照类型自动装配)
    //RestTemplate的方法 ==> url, 请求的实体(request), 响应的类型(response)Class<T>
    //RestTemplate实质上就是提供多种便捷访问远程http服务的方法, 是一个简单的RestFul服务模板
    @Autowired
    private RestTemplate restTemplate;

    //这里去http://localhost:8001/dept/{id}这个url拿数据
    //由于前缀是固定的, 我们这里利用常量写死
    private static final String REST_URL_PREFIX = "http://localhost:8001";
    @RequestMapping("/consumer/dept/get/{id}")
    public Dept get(@PathVariable("id") Long id) {
        //由于我们在provider中的list是get方法, 这里调用getForObject方法
        return restTemplate.getForObject(REST_URL_PREFIX + "/dept/get/" + id, Dept.class);
    }

    @RequestMapping("/consumer/dept/add")
    public boolean add(Dept dept){
        return restTemplate.postForObject(REST_URL_PREFIX + "/dept/add", dept, Boolean.class);
    }

    @RequestMapping("consumer/dept/list")
    public List<Dept> list() {
        return restTemplate.getForObject(REST_URL_PREFIX + "/dept/list", List.class);
    }

}

注意

• 消费者访问应该解耦, 故不应该调用Service层的东西, 为了访问Service提供的资源, 我们通过访问提供者的URL实现资源的访问!
• 利用SpringBoot提供的RestTemplate模板, 我们可以方便的访问远程的http服务的方法(这一点与dubbo+zookeeper实现的功能很相似)
• 使用RestTemplate之前, 一定要注册!
• RestTemplate中的方法的三个参数 : url, 请求的实体(request), 响应的类型(response)Class
• 重复的url可以提取公共部分作为常量
• 消费者提交数据就不用写@RequestBody了, 因为这里利用RestTemplate远程访问, 提交结果的工作实际上还是提供者处承担的

4. 编写主启动类

package com.wang.springcloud;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class DeptConsumer_8080 {
    public static void main(String[] args) {
        SpringApplication.run(DeptConsumer_8080.class, args);
    }
}

5. 测试

注意, 测试的时候一定要同时把提供者打开!

这里利用postman测试