SpringCloud入门学习之Rest服务

最新推荐文章于 2023-11-06 17:16:51 发布

hresh

最新推荐文章于 2023-11-06 17:16:51 发布

阅读量346

点赞数

分类专栏： SpringCloud

本文链接：https://blog.csdn.net/Herishwater/article/details/106292642

版权

SpringCloud 专栏收录该内容

4 篇文章 0 订阅

订阅专栏

文章目录

父模块

1、首先新建一个普通的 maven 项目，作为父级目录，之后的服务提供者和服务消费者都放在该目录下。

2、导入相关依赖，供子模块引用

    <!--集中维护依赖版本-->
    <properties>
        <junit.version>4.12</junit.version>
        <lombok.version>1.18.12</lombok.version>
        <log4j.version>1.2.17</log4j.version>
        <logback.version>1.2.3</logback.version>
    </properties>

    <dependencyManagement>
        <dependencies>
            <!--Cloud依赖-->
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>Greenwich.SR3</version>
                <type>pom</type>
                <scope>runtime</scope>
            </dependency>
            <!--SpringBoot依赖-->
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>2.1.4.RELEASE</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <!--数据库-->
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <version>8.0.19</version>
            </dependency>
            <dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>druid</artifactId>
                <version>1.1.21</version>
            </dependency>

            <!--Mybatis依赖-->
            <dependency>
                <groupId>org.mybatis.spring.boot</groupId>
                <artifactId>mybatis-spring-boot-starter</artifactId>
                <version>2.1.1</version>
            </dependency>
            <!--Junit-->
            <dependency>
                <groupId>junit</groupId>
                <artifactId>junit</artifactId>
                <version>${junit.version}</version>
            </dependency>
            <!--工具类依赖-->
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <version>${lombok.version}</version>
            </dependency>
            <!--日志-->
            <dependency>
                <groupId>log4j</groupId>
                <artifactId>log4j</artifactId>
                <version>${log4j.version}</version>
            </dependency>
            <dependency>
                <groupId>ch.qos.logback</groupId>
                <artifactId>logback-core</artifactId>
                <version>${logback.version}</version>
            </dependency>
        </dependencies>
    </dependencyManagement>

一个父工程包含多个子 Module 模块：

springcloud-api：【封装的实体类接口】

springcloud-provider-dept-8001：【服务提供者】

springcloud-consumer-dept-80：【服务消费者】

服务提供者

数据库环境搭建

1、新建一个数据库

2、构建一个新表，可以通过 SQL 语句执行，也可以在 IDEA 中连接数据库建立新表，如下图所示：

其中 dbSource 字段用于存储数据库名称，在分布式环境下同一张表会存在多个数据库下，因为该字段用于区分数据。

3、新增数据

insert into dept (dpname, dbsource) values ('开发部',DATABASE());
insert into dept (dpname, dbsource) values ('人事部',DATABASE());
insert into dept (dpname, dbsource) values ('财务部',DATABASE());
insert into dept (dpname, dbsource) values ('市场部',DATABASE());
insert into dept (dpname, dbsource) values ('后勤部',DATABASE());

执行成功后，结果如下：

数据筹备

1、新建一个名为 springcloud-api 的普通 maven 项目

2、引用父模块的部分依赖

    <dependencies>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
    </dependencies>

3、新建 Dept 类，实现 Serializable 接口，将对象的内容进行流化，用于数据在网络中传输。

/**
 * chain 的中文含义是链式的，为一个布尔值， 如果为 true 生成的 set 方法返回 this，
 * 为 false 生成的 set 方法是 void 类型。  默认为 false，除非当 fluent 为 true时，chain 默认则为 true 。
 */
@Data
@NoArgsConstructor
@Accessors(chain = true)
public class Dept implements Serializable {
    private long deptId;
    private String dpName;
    private String dbSource;

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

服务提供

1、新建一个名为 springcloud-config-dept-8001 的普通 maven 项目

2、导入依赖

   <dependencies>
        <!--我们需要拿到实体类，所以要配置api module-->
        <dependency>
            <groupId>com.msdn</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>
        <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>

3、新建 mapper 文件，定义接口方法

@Mapper
@Repository
public interface DeptMapper {

    boolean addDept(Dept dept);
    Dept queryDept(long id);
    List<Dept> queryAll();
}

4、在 resources 文件夹下存放 mapper 接口对应的 xml 文件

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.msdn.mapper.DeptMapper">

    <select id="queryDept" resultType="Dept" parameterType="Long">
        select * from springcloud.dept where deptId = #{id}
    </select>

    <insert id="addDept" parameterType="Dept">
        insert into springcloud.dept (dpName,dbSource) values (#{dpName},DATABASE())
    </insert>
    
    <select id="queryAll" resultType="Dept">
        select * from springcloud.dept;
    </select>
</mapper>

5、配置数据库连接以及 mybatis 配置

server:
  port: 8001

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

mybatis:
  type-aliases-package: com.msdn.pojo
  mapper-locations: classpath:mybatis/mapper/*.xml

6、定义 service 层

DeptService

public interface DeptService {

    boolean addDept(Dept dept);
    Dept queryDept(long id);
    List<Dept> queryAll();
}

DeptServiceImpl

@Service
public class DeptServiceImpl implements DeptService {

    @Autowired
    DeptMapper deptMapper;

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

    @Override
    public Dept queryDept(long id) {
        return deptMapper.queryDept(id);
    }

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

7、定义 Controller 层

DeptController

@RestController
public class DeptController {

    @Autowired
    DeptService deptService;

    @GetMapping("/dept/get/{id}")
    public Dept getDept(@PathVariable("id") long id){
        Dept dept = deptService.queryDept(id);
        return dept;
    }

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

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

8、构建执行类

@SpringBootApplication
public class DeptProvider_8001 {

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

整个项目的文件结构如下图所示：

启动该项目，在浏览器访问 http://localhost:8001/dept/list ，即可看到数据库表中的数据。

服务消费者

1、新建一个名为 springcloud-consumer-dept-80 的普通 maven 项目

2、导入依赖

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

3、消费者不需要定义 service 层，可以直接定义 Controller 层来进行数据访问。由于 SpringCloud 中的 RestTemplate 需要注入到容器中，因此我们需要新建一个 config 类。

@Configuration
public class MyConfig {

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

4、DeptConsumerController

@RestController
public class DeptConsumerController {

    @Autowired
    RestTemplate restTemplate;

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

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

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

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

}

5、执行类 DeptConsumer_80

@SpringBootApplication
public class DeptConsumer_80 {

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

6、启动项目，在浏览器中输入 http://localhost/consumer/dept/list （80端口默认不必输入），即可查看数据。

问题记录

当访问 http://localhost/consumer/dept/add?dpName=123 报错，错误如下：

Servlet.service() for servlet [dispatcherServlet] in context with path [] threw exception [Request processing failed; nested exception is org.springframework.web.client.HttpServerErrorException$InternalServerError: 500 null] with root cause

解决方案：去 springcloud-config-dept-8001 项目中的 DeptController 类中修改 add 方法如下：

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

即在方法参数前加上 @RequestBody 注解。

详情代码访问： https://github.com/Acorn2/springcloud-eureka ，如有疑惑可联系我。

参考文献

关注

0
点赞
踩
1

收藏

觉得还不错? 一键收藏
0
评论
SpringCloud入门学习之Rest服务

文章目录父模块服务提供者数据库环境搭建数据筹备服务提供服务消费者问题记录参考文献父模块1、首先新建一个普通的 maven 项目，作为父级目录，之后的服务提供者和服务消费者都放在该目录下。2、导入相关依赖，供子模块引用  <properties> <junit.version>4.12</junit.version> <lombok.version>1.18.12&l
复制链接

扫一扫