微服务 Springboot 项目搭建（四、first-docker Springboot 项目开发）--进行中

微服务 Springboot 项目搭建（一、项目创建）

微服务 Springboot 项目搭建（二、idea本地构建、编译、一键部署服务器运行Docker镜像）

微服务 Springboot 项目搭建（三、项目集成日志log4j框架）

微服务 Springboot 项目搭建（四、first-docker　Springboot 项目开发）

---

一、集成 mybatis框架

1.1新增依赖

        <!-- JDBC -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jdbc</artifactId>
        </dependency>
        <!--MySQL驱动-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.30</version>
        </dependency>
        <!--MyBatis整合SpringBoot框架的起步依赖-->
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>2.2.2</version>
        </dependency>

1.2 建库建表

# 建库语句
CREATE DATABASE first_docker CHARACTER SET utf8;
# 建表语句
DROP TABLE IF EXISTS `t_user_info`;
CREATE TABLE t_user_info(
    user_id VARCHAR(32) NOT NULL COMMENT '用户id' ,
    user_name VARCHAR(32)    COMMENT '姓名' ,
    card_id VARCHAR(128)    COMMENT '身份证号' ,
    CREATED_TIME DATETIME    COMMENT '创建时间' ,
    UPDATED_TIME DATETIME    COMMENT '更新时间' ,
    PRIMARY KEY (user_id)
) COMMENT = 't_user_info 用户表';

1.3 创建UserInfoMapper.java

@Mapper
public interface UserInfoMapper {
    /**
     * 插入数据
     * @param tableName 数据库表名
     * @param userInfo 用户信息
     * @return 返回数量
     */
    int insert(String tableName, UserInfo userInfo);

    int insert2(UserInfo userInfo);

    /**
     * 查询单个 UserInfo信息
     * @param tableName 数据库表名
     * @param userId 用户Id
     * @return 返回UserInfo信息
     */
    UserInfo selectOne(@Param("tableName") String tableName, @Param("id") String userId);

    /**
     * 查询所有UserInfo信息
     * @param tableName 数据库表名
     * @return 返回所有UserInfo信息集合
     */
    List<UserInfo> selectAll(String tableName);
}

1.4 创建UserInfoMapper.xml

路径：src/main/resources/mappers/UserInfoMapper.xml

<?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">
<!-- 本映射文件对应UserInfoMapper接口 -->
<mapper namespace="com.manchi.firstdocker.mapper.UserInfoMapper">
    <!-- 对应UserInfoMapper中的insert方法 -->
    <insert id="insert" parameterType="userInfo">
        insert into ${tableName} (user_id, user_name, card_id, CREATED_TIME, UPDATED_TIME)
        values (#{userInfo.userId}, #{userInfo.userName}, #{userInfo.cardId}, #{userInfo.createdTime}, #{userInfo.updatedTime})
    </insert>

    <insert id="insert2" parameterType="userInfo">
        insert into t_user_info (user_id, user_name, card_id, CREATED_TIME, UPDATED_TIME)
        values (#{userId}, #{userName}, #{cardId}, #{createdTime}, #{updatedTime})
    </insert>

    <!-- 对应UserInfoMapper中的selectOne方法 -->
    <select id="selectOne" resultMap="resultMapBase" parameterType="java.lang.String">
        select
        <include refid="sqlBase"/>
        from ${tableName} where user_id = #{id}
    </select>
    <!-- 对应UserInfoMapper中的selectAll方法 -->
    <select id="selectAll" resultMap="resultMapBase">
        select
        <include refid="sqlBase"/>
        from ${tableName}
    </select>
    <!-- 可复用的sql模板 -->
    <sql id="sqlBase">
        user_id
        ,user_name,card_id,CREATED_TIME,UPDATED_TIME
    </sql>
    <!-- 保存SQL语句查询结果与实体类属性的映射 -->
    <resultMap id="resultMapBase" type="UserInfo">
        <id column="user_id" property="userId"/>
        <result column="user_name" property="userName"/>
        <result column="card_id" property="cardId"/>
        <result column="CREATED_TIME" property="createdTime"/>
        <result column="UPDATED_TIME" property="updatedTime"/>
    </resultMap>
</mapper>

1.5 修改application.properties

spring.application.name=first-docker
server.port=8080
#数据库参数
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/first_docker?useUnicode=true&characterEncoding=UTF-8&useJDBCComliantTimezoneShift=true&useLegacyDatetimeCode=false&serverTimezone=GMT%2B8
spring.datasource.username=root
spring.datasource.password=123456

# MyBatis 配置
mybatis.mapper-locations=classpath:mappers/*Mapper.xml
mybatis.type-aliases-package=com.manchi.firstdocker.entity

1.6 新增测试类.UserInfoMapperTest.java

com.manchi.firstdocker.UserInfoMapperTest.java

@RunWith(SpringRunner.class)
@SpringBootTest(classes = FirstDockerApplication.class)
public class UserInfoMapperTest {
    @Resource
    private UserInfoMapper userInfoMapper;

    // 测试新增用户
    @Test
    public void testInsert() {
        UserInfo userInfo = new UserInfo();
        userInfo.setUserId("1002");
        userInfo.setUserName("张三2");
        userInfo.setCardId("3412261988811065152");
        userInfo.setCreatedTime(new Date());
        Date date = new Date(System.currentTimeMillis());
        DateFormat dateFormat = new SimpleDateFormat("MMddhhmmss");
        String format = dateFormat.format(date);
        System.out.println(format);
        userInfo.setUpdatedTime(new Date());
        int count = userInfoMapper.insert(Constant.TABLE_NAME, userInfo);
        assertEquals(1, count); // count值为1,则测试通过
    }

    // 测试查询单个用户
    @Test
    public void testSelectOne() {
        UserInfo userInfo = userInfoMapper.selectOne(Constant.TABLE_NAME, "1000");
        System.out.println(userInfo);
        assertEquals("1000", userInfo.getUserId()); // count值为1,则测试通过
    }

    // 测试查询单个用户
    @Test
    public void testSelectAll() {
        List<UserInfo> userInfos = userInfoMapper.selectAll(Constant.TABLE_NAME);
        System.out.println(userInfos);
        assertEquals(3, userInfos.size()); // count值为1,则测试通过
    }
}

测试通过

三、统一异常处理类

参考文档：https://blog.csdn.znet/qq_43102730/article/details/127248249?spm=1001.2101.3001.6650.1&utm_medium=distribute.pc_relevant.none-task-blog-2%7Edefault%7ECTRLIST%7ERate-1-127248249-blog-121952445.235%5Ev27%5Epc_relevant_3mothn_strategy_recovery&depth_1-utm_source=distribute.pc_relevant.none-task-blog-2%7Edefault%7ECTRLIST%7ERate-1-127248249-blog-121952445.235%5Ev27%5Epc_relevant_3mothn_strategy_recovery&utm_relevant_index=2

3.1 自定义异常类

我们在搭建模块时在common模块可以新建CustomException类。

3.1.1 BaseException类

@AllArgsConstructor
@NoArgsConstructor
public class BaseException extends RuntimeException {

    private static final long serialVersionUID = 4073384547445952552L;

    private HttpStatus httpStatus;

    private Integer code;

    private String message;

    public HttpStatus getHttpStatus() {
        return httpStatus;
    }

    public Integer getCode() {
        return code;
    }

    public void setMessage(String message) {
        this.message = message;
    }

    @Override
    public String getMessage() {
        return message;
    }

    public BaseException newInstance(String message) {
        return new BaseException(httpStatus, code, message);
    }

3.1.2 SystemException 系统异常类

public class SystemException extends BaseException {
    // 成功
    public static final SystemException SUCCESS = new SystemException(HttpStatus.OK, 20000, "SUCCESS");
    // 内部异常
    public static final SystemException INTERNAL_SERVER_ERROR =
            new SystemException(HttpStatus.INTERNAL_SERVER_ERROR, 20001, "服务内部错误");
    // 参数错误
    public static final SystemException PARAMETER_ERROR =
            new SystemException(HttpStatus.INTERNAL_SERVER_ERROR, 20002, "参数不正确");
    // ....等等异常
    
    private static final long serialVersionUID = -3700178436214390486L;

    public SystemException(HttpStatus httpStatus, Integer code, String message) {
        super(httpStatus, code, message);
    }
}

3.1.3 ResultCodeEnum 枚举类

@Getter
public enum ResultCodeEnum {

    SUCCESS(20000,"成功"),

    FAIL(21000,"失败"),

    UNKNOWN_ERROR(20001,"未知错误"),

    PARAM_ERROR(20002,"参数错误");

    private Integer code;
    private String message;

    ResultCodeEnum() {
    }

    ResultCodeEnum(Integer code, String message) {
        this.code = code;
        this.message = message;
    }
}

3.2 创建统一返回结果类 ResponseResult

@Data
public class ResponseResult<T> {
    private Integer code;
    private String message;
    private T date;

    public ResponseResult() {
    }

    protected static <T> ResponseResult<T> build(T date) {
        ResponseResult<T> result = new ResponseResult<>();
        if (date != null) {
            result.setDate(date);
        }
        return result;
    }

    public static <T> ResponseResult<T> build(T date, ResultCodeEnum resultCodeEnum) {
        ResponseResult<T> result = build(date);
        result.setCode(resultCodeEnum.getCode());
        result.setMessage(resultCodeEnum.getMessage());
        return result;
    }

    public static <T> ResponseResult<T> build(Integer code, String message) {
        ResponseResult<T> result = build(null);
        result.setCode(code);
        result.setMessage(message);
        return result;
    }

    /**
     * 返回成功
     *
     * @param date 数据
     * @param <T>  返回类型
     * @return 返回值
     */
    public static <T> ResponseResult<T> ok(T date) {
        return build(date, ResultCodeEnum.SUCCESS);
    }

    public static <T> ResponseResult<T> ok() {
        return ResponseResult.ok(null);
    }

    /**
     * 返回失败
     *
     * @param date 失败信息
     * @param <T>  返回类型
     * @return 返回值
     */
    public static <T> ResponseResult<T> fail(T date) {
        return build(date, ResultCodeEnum.FAIL);
    }

    public static <T> ResponseResult<T> fail() {
        return ResponseResult.fail(null);
    }

    public static <T> ResponseResult<T> fail(BaseException baseException) {
        return build(baseException.getCode(), baseException.getMessage());
    }

    public ResponseResult<T> message(String msg) {
        this.setMessage(msg);
        return this;
    }

    public ResponseResult<T> code(Integer code) {
        this.setCode(code);
        return this;
    }

    /**
     * 判断是否成功
     *
     * @return 返回 true 或 false
     */
    public boolean isOk() {
        if (this.getCode().intValue() == ResultCodeEnum.SUCCESS.getCode().intValue()) {
            return true;
        }
        return false;
    }
}

3.3 创建全局异常处理类

@ControllerAdvice 用法
顾名思义，@ControllerAdvice就是@Controller 的增强版。@ControllerAdvice主要用来处理全局数据，一般搭配@ExceptionHandler、@ModelAttribute以及@InitBinder使用。

全局异常处理
@ControllerAdvice最常见的使用场景就是全局异常处理。比如文件上传大小限制的配置，如果用户上传的文件超过了限制大小，就会抛出异常,
此时可以通过@ControllerAdvice结合@ExceptionHandler定义全局异常捕获机制

//@ControllerAdvice就是@Controller 的增强版。@ControllerAdvice主要用来处理全局数据，
// 一般搭配@ExceptionHandler、@ModelAttribute以及@InitBinder使用。
@ControllerAdvice
public class ControllerExceptionHandler {
    public static final Logger LOG = LoggerFactory.getLogger("RUNTIME_LOG");

    /**
     * 处理系统异常
     *
     * @param baseException 抛出的系统异常
     * @return ErrorResponse
     */
    @ExceptionHandler(value = BaseException.class)
    public ResponseResult handleBaseException(BaseException baseException) {
        LOG.error("Biz Exception" + baseException);
        return ResponseResult.ok(baseException);
    }

    /**
     * 处理为止异常
     *
     * @param throwable 抛出的业务异常对象
     * @return ErrorResponse
     */
    @ExceptionHandler(value = Throwable.class)
    public ResponseResult handleThrowable(Throwable throwable) {
        LOG.error("System Exception" + throwable);
        return ResponseResult.fail(SystemException.INTERNAL_SERVER_ERROR);
    }
}

四、定时任务

4.1scheduled.task.config.properties 配置文件

src/main/resources/scheduled.task.config.properties

userinfo.insertSchedule=0 */1 * * * ?

4.2 InsertUserInfoJob 定时任务

@EnableScheduling
@Controller
@PropertySource("classpath:/scheduled.task.config.properties")
public class InsertUserInfoJob {
    private static final String RUNTIME_LOG = "info";

    private static Logger LOG = Logger.getLogger(RUNTIME_LOG);
//    private static final Logger LOG = LoggerFactory.getLogger(RUNTIME_LOG);

    @Autowired
    InsertUserInfoMapper insertUserInfoMapper;

    @Scheduled(cron = "${userinfo.insertSchedule}")
    public void execute() {
        try {
            LOG.info("start executing insert user scheduled task");
            UserInfo userInfo = new UserInfo();
            Date date = new Date(System.currentTimeMillis());
            DateFormat dateFormat = new SimpleDateFormat("MMddhhmmss");
            String format = dateFormat.format(date);
            userInfo.setUserId(format);
            userInfo.setUserName("张三:" + format);
            userInfo.setCardId("3412261988811065153");
            userInfo.setCreatedTime(new Date());
            userInfo.setUpdatedTime(new Date());
            insertUserInfoMapper.insert2(userInfo);
//            LOG.info("success to insert user by userId :{}", userInfo.getUserId());
            LOG.info("success to insert user by userId :" + userInfo.getUserId());
        } catch (RuntimeException e) {
            LOG.info("fail to insert user because of :{}", e);
        }
    }
}