分布式医疗挂号系统(一) | 搭建医院设置微服务模块

àì夳堔傛蜴生んèń 2022-10-22 04:15 127阅读 0赞

> 本系列文章介绍从0开始搭建一个基于分布式的医疗挂号系统。本次四篇文章完成了`医院设置微服务模块`的后端接口，为了方便开发，对`接口的返回结果`、`全局异常`、`全局日志`进行了统一处理。 同时，为了方便进行访问测试，还`整合了Swagger2工具`，这些通用的模块中，除了`全局日志`被放在医院设置微服务模块的配置资源中，其余都统一被抽取在common模块中。具体实现可参考下面文章：
> 
>  *  [医院设置微服务 | 模块搭建][Link 1]
>  *  [医院设置微服务 | 接口开发][Link 2]
>  *  [通用模块 | 整合Swagger2][_ _Swagger2]
>  *  [通用模块 | 统一返回结果、统一异常处理、统一日志处理][Link 3]
> 
> --------------------
> 
> 作者：Hudie  
> 微信公众号/CSDN博客：编程一只蝶  
> 公众号文章会比博客早1到2天，欢迎关注，每天开心~  
> 项目已开源至gitee：[https://gitee.com/guo-qianliang/yygh\_parent][https_gitee.com_guo-qianliang_yygh_parent]  
> 项目已开源至github：[https://github.com/Guoqianliang/yygh\_parent][https_github.com_Guoqianliang_yygh_parent]

### 医院设置微服务模块搭建 ###

*  一、项目模块划分图
 *  二、开发前的准备工作
 *   *  1.医院设置数据库表设计
     *  2.搭建医院设置微服务模块
 *  三、医院设置微服务模块开发
 *   *  步骤1：生成表对应的实体类
     *  步骤2：创建Mapper
     *  步骤3：创建Service
     *  步骤4：创建Controller
 *  四、测试开发环境

--------------------

# 一、项目模块划分图 #

本系列文章开始介绍从0开始搭建一个《基于分布式的医疗挂号系统》，下图是初步模块划分图，可根据此图在IDEA中创建出项目初步结构。其中父工程是一个Spring工程，父模块是Maven工程，注意两者都需要使用pom方式进行打包。

![初步模块划分图][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzY5MTA1OA_size_1_color_FFFFFF_t_70]

# 二、开发前的准备工作 #

## 1.医院设置数据库表设计 ##

在《基于分布式的医疗预约挂号系统》中，`医院设置表yygh_hosp`主要是用来保存每个医院的一些基本信息，每个医院的信息就是一条记录。这条记录中保存了医院编号、接口调用相关的签名等等。只有开通了医院设置，才可以进行医院记录的上传。所以，在医院设置模块部分，我们所开发的功能就是基于单表的一个CRUD、发送签名信息等基本功能。

# 创建数据库: yygh_hosp
    CREATE DATABASE IF NOT EXISTS `yygh_hosp` CHARACTER SET utf8mb4;
    USE `yygh_hosp`;
    
    # 创建表:hospital_set
    CREATE TABLE `hospital_set` (
      `id` BIGINT(20) NOT NULL AUTO_INCREMENT COMMENT '编号',
      `hosname` VARCHAR(100) DEFAULT NULL COMMENT '医院名称',
      `hoscode` VARCHAR(30) DEFAULT NULL COMMENT '医院编号',
      `api_url` VARCHAR(100) DEFAULT NULL COMMENT 'api基础路径',
      `sign_key` VARCHAR(50) DEFAULT NULL COMMENT '签名秘钥',
      `contacts_name` VARCHAR(20) DEFAULT NULL COMMENT '联系人',
      `contacts_phone` VARCHAR(11) DEFAULT NULL COMMENT '联系人手机',
      `status` TINYINT(3) NOT NULL DEFAULT '0' COMMENT '状态',
      `create_time` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
      `update_time` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '更新时间',
      `is_deleted` TINYINT(3) NOT NULL DEFAULT '0' COMMENT '逻辑删除(1:已删除，0:未删除)',
      PRIMARY KEY (`id`),
      UNIQUE KEY `uk_hoscode` (`hoscode`) COMMENT '唯一约束(医院编号必须唯一)'
    ) ENGINE=INNODB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8 COMMENT='医院设置表';

创建好后的数据库表如下：  
![医院信息表][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzY5MTA1OA_size_1_color_FFFFFF_t_70 1]

## 2.搭建医院设置微服务模块 ##

在servie父模块中创建`service_hosp模块`，为`service_hosp模块`添加如下配置信息：

# 服务端口
    server.port=8201
    # 服务名
    spring.application.name=service-hosp
    
    # 环境设置：dev、test、prod
    spring.profiles.active=dev
    
    # mysql数据库连接
    spring.datasource.driver-class-name=com.mysql.jdbc.Driver
    spring.datasource.url=jdbc:mysql://[ip地址]:3306/yygh_hosp?characterEncoding=utf-8&useSSL=false
    spring.datasource.username=[数据库名称]
    spring.datasource.password=[数据库密码]
    
    #返回json的全局时间格式
    spring.jackson.date-format=yyyy-MM-dd HH:mm:ss
    spring.jackson.time-zone=GMT+8

并为此微服务模块创建启动类：

package com.gql.yygh.hosp;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    /** * @Description: 启动类 * @author Guoqianliang * @date 20:17 - 2021/4/3 */
    @SpringBootApplication
    public class ServiceHospApplication { 
        public static void main(String[] args) { 
            SpringApplication.run(ServiceHospApplication.class, args);
        }
    }

在测试前，将service模块中下图所示的三个依赖注释掉，这些现在还用不到。若不注释，启动时项目会报错。  
![需要被注释的依赖][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzY5MTA1OA_size_1_color_FFFFFF_t_70 2]  
运行此微服务，发现项目成功启动：  
![微服务启动成功][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzY5MTA1OA_size_1_color_FFFFFF_t_70 3]  
至此，医院设置数据库表，以及医院微服务模块搭建成功，后续就可以在此基础上进行接口的编写了。

# 三、医院设置微服务模块开发 #

## 步骤1：生成表对应的实体类 ##

> 此处在编写实体类时使用了一个父子类来做映射，这样做是为了将公用的字段给抽取出来。
> 
>  *  `在继承中，子类继承父类就拥有了父类的全部非私有属性。`

![与yygh\_hosp数据库表对应的实体类][yygh_hosp]

## 步骤2：创建Mapper ##

> MyBatis-Plus在Mapper层为我们提供了一个`BaseMapper<T>接口`，继承这个接口，即可获得CRUD功能。

![Mapper层][Mapper]

> mapper一般对应一个`xml配置文件`，下面对xml的开发规范进行补充：
> 
>  *  `mapper接口的地址`通过.xml中的`namespace`属性引入。
>  *  mapper接口中`方法名`和.xml中`id`一致。
>  *  mapper接口中`方法输入参数类型`和.xml中statement的`parameterType指定的类型`一致。
>  *  mapper接口中`方法返回值类型`和.xml中statement的`resultType指定的类型`一致。

由于Mapperapper是一个接口，接口动态生成实现类的对象默认是找不到的，需要添加MapperScan才能找到动态生成的对象。可以将MapperScan写在启动类上，也可以如下所示编写一个配置类进行统一管理。

package com.gql.yygh.hosp.config;
    
    import org.mybatis.spring.annotation.MapperScan;
    import org.springframework.context.annotation.Configuration;
    
    /** * @Description: 医院配置 * @author Guoqianliang * @date 9:42 - 2021/4/4 */
    @Configuration
    @MapperScan("com.gql.yygh.hosp.mapper")
    public class HospConfig { 
    
    }

## 步骤3：创建Service ##

> MyBatis-Plus在Service层为我们提供了一个`IService接口`和一个`ServiceImpl`实现类，我们的Service接口继承IService接口、我们的实现类继承ServiceImpl实现类。就可以让MyBatis-Plus在Service层帮我们去调用Mapper，直接使用封装号的`baseMapper`就能完成调用。

![Service层][Service]

## 步骤4：创建Controller ##

> 创建Controller，在其中装配Service即可，后续在Controller中调用Service层的方法，进而调用数据库即可实现功能。

/** * @Description: Controller * @author Guoqianliang * @date 0:16 - 2021/4/4 */
    @RestController
    @RequestMapping("/admin/hosp/hospitalSet")
    public class HospitalSetController { 
        /** * 注入Service */
        @Autowired
        private HospitalSetService hospitalSetService;
    
    }

# 四、测试开发环境 #

为了验证环境的正确性，下面对微服务整体进行测试，我们在Controller中编写一个查询数据库所有信息的方法。

@RestController
    @RequestMapping("/admin/hosp/hospitalSet")
    public class HospitalSetController { 
        /** * 注入Service */
        @Autowired
        private HospitalSetService hospitalSetService;
    
        /** * 测试:查询医院设置表中的所有记录 * @return list */
        @GetMapping("findAll")
        public List<HospitalSet> findAllHospitalSet() { 
            List<HospitalSet> list = hospitalSetService.list();
            return list;
        }
    
    }

手动在yygh\_hosp数据库hospital\_set表中添加一条记录：  
![添加一条记录进行测试][20210404153743100.png]

将微服务跑起来，在浏览器访问url：`http://localhost:8201/admin/hosp/hospitalSet/findAll`，成功获取到json格式的信息：  
![成功获取json信息][json]

至此，医院设置微服务模块就搭建成功了，接下来就可以在此环境上进行接口的开发。

[Link 1]: https://blog.csdn.net/weixin_43691058/article/details/115419552?spm=1001.2014.3001.5502
[Link 2]: https://blog.csdn.net/weixin_43691058/article/details/115437742?spm=1001.2014.3001.5502
[_ _Swagger2]: https://blog.csdn.net/weixin_43691058/article/details/115439245?spm=1001.2014.3001.5502
[Link 3]: https://blog.csdn.net/weixin_43691058/article/details/115447130?spm=1001.2014.3001.5502
[https_gitee.com_guo-qianliang_yygh_parent]: https://gitee.com/guo-qianliang/yygh_parent
[https_github.com_Guoqianliang_yygh_parent]: https://github.com/Guoqianliang/yygh_parent
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzY5MTA1OA_size_1_color_FFFFFF_t_70]: /images/20221022/7d3ba187253d41fcad4a6f8fba3a341e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzY5MTA1OA_size_1_color_FFFFFF_t_70 1]: /images/20221022/570bd86bc5a647ef83426a2bcfbc4f4f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzY5MTA1OA_size_1_color_FFFFFF_t_70 2]: /images/20221022/1655859e6d744f5c902821125805e749.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzY5MTA1OA_size_1_color_FFFFFF_t_70 3]: /images/20221022/60db245126ef402e9e95ac7038a15fbf.png
[yygh_hosp]: /images/20221022/467996fab57f4849b31a4ca457964bdd.png
[Mapper]: /images/20221022/bd89976ae6c9414889093a8259df6184.png
[Service]: /images/20221022/a88b8d948ce94517b3137196c31c013f.png
[20210404153743100.png]: /images/20221022/2c9107befbdf41c8b1dbb4815e60b586.png
[json]: /images/20221022/ba4bb36792f4431ea2e896ae9ba289d9.png