SpringCloud -- Rest学习(项目分层，分解为对应模块) -- 环境搭建

1. 介绍

使用一个Dept部门模块做一个微服务通用案例Consumer消费者(Client)通过REST调用Provider提供者(Server)提供的服务

Maven的分包分模块架构复习。
一个简单的Maven模块结构是这样的：

-- app-parent: 一个父项目(app-parent)聚合了很多子项目(app-util\app-dao\app-web...)
  |-- pom.xml
  |
  |-- app-core
  ||---- pom.xml
  |
  |-- app-web
  ||---- pom.xml
  ......

Dept部门模块springcloud父工程(Project)下初次带着3个子模块(Module)

• springcloud-api 【封装的整体entity/接口/公共配置等】
• springcloud-consumer-dept-80 【服务消费者】
• springcloud-provider-dept-8001 【服务提供者】

2. springcloud父工程

2.1 创建一个父工程 – springcloud

2.2 在pom.xml中添加依赖管理

• dependencyManagement只管理依赖，不会自动导入依赖

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

    <!--版本统一配置，方便管理-->
    <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.13.2</junit.version>
        <lombok.version>1.18.20</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>2020.0.4</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <!-- springboot依赖 -->
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>2.5.5</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <!-- 数据库 -->
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <version>8.0.26</version>
            </dependency>
            <!-- 数据源 -->
            <dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>druid</artifactId>
                <version>1.1.12</version>
            </dependency>
            <!-- springboot启动器 -->
            <dependency>
                <groupId>org.mybatis.spring.boot</groupId>
                <artifactId>mybatis-spring-boot-starter</artifactId>
                <version>2.2.0</version>
            </dependency>
            <!--junit-->
            <dependency>
                <groupId>junit</groupId>
                <artifactId>junit</artifactId>
                <version>${junit.version}</version>
                <scope>test</scope>
            </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>
            <!--logback-->
            <dependency>
                <groupId>ch.qos.logback</groupId>
                <artifactId>logback-core</artifactId>
                <version>1.2.6</version>
            </dependency>
        </dependencies>
    </dependencyManagement>

3. springcloud-api 子模块【封装的整体entity/接口/公共配置等】

3.1 在父工程中添加模块(Module) – springcloud-api

在创建时继承父工程springcloud

创建完成后会自动在 父工程springcloud的pom.xml中 模块列表添加该模块

    <modules>
        <module>springcloud-api</module>
        <module>springcloud-provider-dept-8001</module>
        <module>springcloud-consumer-dept-80</module>
    </modules>

模块pom.xml中也自动继承了父工程springcloud

<parent>
    <artifactId>springcloud</artifactId>
    <groupId>com.yanyu</groupId>
    <version>1.0-SNAPSHOT</version>
</parent>

3.2 添加模块所需依赖

• 当前的Model所需要的依赖,若父依赖中已经配置了版本，在此引用即可，不需配置版本号

    <!--当前的Model所需要的依赖,若父依赖中已经配置了版本，在此引用即可，不需配置版本号-->
    <dependencies>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
    </dependencies>
</project>

3.3 添加实体类

• 网络通信需实现序列化接口

/**网络通信实现序列化接口*/
@Data
@NoArgsConstructor
@Accessors(chain = true) //开启链式写法
public class Dept implements Serializable {
    private Long deptno;
    private String dname;
    /**db_source表示s数据所属的数据库*/
    private String db_source;

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

4. springcloud-provider-dept-8001 子模块 【服务提供者】

4.1 在父工程中添加模块(Module) – springcloud-provider-dept-8001

在创建时继承父工程springcloud

4.2 添加模块所需依赖

    <dependencies>
        <!--springcloud-api -->
        <dependency>
            <groupId>com.yanyu</groupId>
            <artifactId>springcloud-api</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
        <!--junit-->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
        </dependency>
        <!--mysql-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
        <!--druid-->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
        </dependency>
        <!--logback-->
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-core</artifactId>
        </dependency>
        <!--mybtis-->
        <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>

4.3 配置文件

4.3.1 在资源目录下创建mybatis配置文件 mybatis-config.xml

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

4.3.2 在资源目录下springboot配置文件 – application.xml

#端口配置
server:
  port: 8081

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

#spring配置
spring:
  application:
    name: springcloud-provider-dept
  datasource:
    type: com.alibaba.druid.pool.DruidDataSource
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/db01?useUnicode=true&characterEncoding=utf-8&serverTimezone=UTC
    username: root
    password: root

4.4 创建dao层和mapper层文件

DeptDao

@Mapper
@Repository
public interface DeptDao {

    public boolean addDept(Dept dept);

    public Dept queryById(Long id);

    public List<Dept> queryAll();
}

DeptMapper.xml

<?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.yanyu.springcloud.dao.DeptDao">

    <insert id="addDept" parameterType="com.yanyu.springcloud.pojo.Dept">
        insert into dept (dname, db_source)
        values (#{dname},DATABASE())
    </insert>
    <select id="queryById" resultType="com.yanyu.springcloud.pojo.Dept" parameterType="Long">
        select * from dept where deptno = #{deptno}
    </select>
    <select id="queryAll" resultType="com.yanyu.springcloud.pojo.Dept">
        select * from dept;
    </select>
</mapper>

4.5 创建service层文件,调用对应dao层,获取数据

DeptService

public interface DeptService {
    public boolean addDept(Dept dept);

    public Dept queryById(Long id);

    public List<Dept> queryAll();
}

DeptServiceImpl

@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 id) {
        return deptDao.queryById(id);
    }

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

4.6 创建controller层文件,获取请求并处理

DeptController

/**
 * @author yanyu
 * 提供Restful服务!
 */
@RestController
public class DeptController {

    @Autowired
    private DeptService deptService;

    @PostMapping("/dept/add")
    public boolean addDept(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();
    }
}

4.7 创建程序入口 – 启动类

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

5. springcloud-consumer-dept-80 子模块 【服务消费者】

5.1 在父工程中添加模块(Module) – springcloud-consumer-dept-80

在创建时继承父工程springcloud

5.2 添加模块所需依赖

    <dependencies>
        <!--api-->
        <dependency>
            <groupId>com.yanyu</groupId>
            <artifactId>springcloud-api</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
        <!--web-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
        </dependency>
    </dependencies>

5.3 在资源目录下springboot配置文件 – application.xml

server:
  port: 80

5.4 创建配置类ConfigBean – 用于加载Bean

• RestTemplate 提供多种便捷访问远ttp服务的方法,简单 Restful服务模饭

@Configuration
public class ConfigBean {
    @Bean
    public RestTemplate getRestTemplate() {
        return new RestTemplate();
    }
}

5.5 创建controller层文件,获取请求并处理

获取消费者请求并调用对应服务者请求

@RestController
public class DeptConsumerController {
    /**
     * RestTemplate 提供多种便捷访问远ttp服务的方法,简单 Restful服务模饭
     * 我们直接调用就可以了!
     * 注册到spring中
     * */
    @Autowired
    private RestTemplate restTemplate;

    private static final String REST_URL_PREFIX ="http://localhost:8081";

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

    @RequestMapping("/consumer/dept/get/{id}")
    public Dept get(@PathVariable("id") Long id){
        return restTemplate.getForObject(REST_URL_PREFIX+"/dept/get/"+id,Dept.class);
    }

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

}

5.6 创建程序入口 – 启动类

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

}