写在前面的话:
因该系列文章后期会结合实际项目,实行前后分离开发模式,故从此节开始,均以编写接口的方式来整合各技术,以postman测试接口结果。
——技术之路浩如烟海,耳根所及不过毫厘
一、前情概要:
二、环境介绍:
开发平台:windows
开发工具:IDEA
测试工具:POSTMAN
SpringBoot Version is 2.x
三、整合过程
1、pom文件添加依赖:(在上一章基础上添加)
<!--数据库连接池--> <dependency> <groupId>com.alibaba</groupId> <artifactId>druid-spring-boot-starter</artifactId> <version>1.1.13</version> </dependency> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <scope>runtime</scope> </dependency> <dependency> <groupId>log4j</groupId> <artifactId>log4j</artifactId> <version>1.2.17</version> </dependency> <!--Data注解--> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> </dependency> <!--mybatis-plus--> <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>${mybatisplus.version}</version> </dependency> <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding> <java.version>1.8</java.version> <mybatisplus.version>3.1.1</mybatisplus.version> </properties>
2、准备mysql数据库,建表如下:
3、IDEA连接数据库,如下所示:
自行填入相关数据库信息,点击Test Connection,测试成功点击Ok即可。如下图
4、生成实体类:【此处可用 mybatis-plus-generator生成】
右键,如图:
对实体类做一系列操作:
@Data @TableName("t_sys_user") public class TSysUser { private String userId; private String loginName; private String realName; private String userPassword; private java.sql.Timestamp lastLoginTime; private String remark; }
5、编写配置文件:
#mysql spring.datasource.type=com.alibaba.druid.pool.DruidDataSource spring.datasource.driver-class-name=com.mysql.jdbc.Driver spring.datasource.url=jdbc:mysql://***.***.***.***:****/*****?useUnicode=true&characterEncoding=utf-8 spring.datasource.username=***** spring.datasource.password=***** #druid # 初始化大小,最小,最大 spring.datasource.druid.initial-size=5 spring.datasource.druid.minIdle=5 spring.datasource.druid.maxActive=20 # 配置获取连接等待超时的时间 spring.datasource.druid.maxWait=60000 # 配置间隔多久才进行一次检测,检测需要关闭的空闲连接,单位是毫秒 spring.datasource.druid.timeBetweenEvictionRunsMillis=60000 # 配置一个连接在池中最小生存的时间,单位是毫秒 spring.datasource.druid.minEvictableIdleTimeMillis=300000 # 校验SQL,Oracle配置 spring.datasource.validationQuery=SELECT 1 FROM DUAL,如果不配validationQuery项,则下面三项配置无用 spring.datasource.druid.validationQuery=SELECT 'x' spring.datasource.druid.testWhileIdle=true spring.datasource.druid.testOnBorrow=false spring.datasource.druid.testOnReturn=false # 打开PSCache,并且指定每个连接上PSCache的大小 spring.datasource.druid.poolPreparedStatements=true spring.datasource.druid.maxPoolPreparedStatementPerConnectionSize=20 # 配置监控统计拦截的filters,去掉后监控界面sql无法统计,'wall'用于防火墙 spring.datasource.druid.filters=stat,wall,log4j # 通过connectProperties属性来打开mergeSql功能;慢SQL记录 spring.datasource.druid.connectionProperties=druid.stat.mergeSql=true;druid.stat.slowSqlMillis=5000 # 合并多个DruidDataSource的监控数据 spring.datasource.druid.useGlobalDataSourceStat=true mybatis-plus.mapper-locations=classpath:/mapper/**/*Mapper.xml
对*Mapper文件的扫描,文件目录如下图所示:
6、创建controller、service/impl、mapper:
/** * 用户controller * @author Francis * @date 2019-02-24 11:50 */ @RestController @RequestMapping("/api/user") public class UserController { @Autowired private UserService userService; /** * 获取所有用户 * @return */ @RequestMapping(value = "", method = RequestMethod.GET, produces = "application/json;charset=UTF-8") public Map<String, Object> getAllUser(){ List<TSysUser> userList = userService.list(null); return BaseResult.ajaxReturnSuccess(userList); } } /** * 用户service接口 * @author Francis * @date 2019-02-24 11:53 */ public interface UserService extends IService<TSysUser>{ } /** * 用户service实现类 * @author Francis * @Date 2019-02-24 11:54 */ @Service public class UserServiceImpl extends ServiceImpl<UserMapper, TSysUser> implements UserService{ @Autowired private UserMapper userMapper; } /** * 用户持久层接口 * @author Francis * @date 2019-02-24 11:56 */ @Mapper public interface UserMapper extends BaseMapper<TSysUser>{ }
配置文件代码:
/** * 异常信息 key and value * @author Francis * @date 2019-02-24 11:20 */ @Data public class CodeMsg { private int code; private String msg; private CodeMsg( int code,String msg ) { this.code = code; this.msg = msg; } public static CodeMsg PARAM_NOT_PASS = new CodeMsg(1000, "参数校验不通过"); public static CodeMsg DB_ERROR = new CodeMsg(1100, "数据库异常"); //insert异常 public static CodeMsg INSERT_ERROR = new CodeMsg(1200, "新增数据失败,请检查数据有效性。"); //update delete异常 public static CodeMsg DATA_DEAL_ERROR = new CodeMsg(1201, "未处理到任何一行"); //select异常 public static CodeMsg DATA_IS_EMPTY = new CodeMsg(1202, "未查询到任何一条数据"); } /** * 创建一系列常量参数 * @author Francis * @date 2019-02-24 11:18 */ public class Constants { /** * 系统常量 */ public static final Integer SUCCESS = 200; } /** * 封装返回值 * * @author Francis * @version 1.0 * @date 2019-02-24 11:28 */ @Data public class BaseResult { /** * 对外调用 -- 标准Ajax返回 * @param code * @param data * @param message * @return */ public static Map<String,Object> ajaxReturn(Integer code, String message, Object data){ Map<String,Object> jsonMap = new HashMap<>(); jsonMap.put("code", code); jsonMap.put("payload", data); jsonMap.put("msg", message); return jsonMap; } /** * 对外调用 -- 异常时返回 * @param codeMsg * @return */ public static Map<String,Object> ajaxReturnError(CodeMsg codeMsg){ Map<String,Object> jsonMap = new HashMap<>(); jsonMap.put("code", codeMsg.getCode()); jsonMap.put("payload", null); jsonMap.put("msg", codeMsg.getMsg()); return jsonMap; } /** * 对外调用 -- 正确时返回 * @param object * @return */ public static Map<String,Object> ajaxReturnSuccess(Object object){ Map<String,Object> jsonMap = new HashMap<>(); jsonMap.put("code", SUCCESS); jsonMap.put("payload", object); jsonMap.put("msg", "操作成功!"); return jsonMap; } } /** * Mybatis-Plus -- Config * @author Francis * @date 2019-02-04 11:40 */ @Configuration @EnableTransactionManagement public class MybatisPlusConfig { @Bean public PaginationInterceptor paginationInterceptor() { PaginationInterceptor paginationInterceptor = new PaginationInterceptor(); paginationInterceptor.setDialectType("mysql"); return paginationInterceptor; } /** * sql性能调试 -- 开发阶段使用 * @return */ @Bean public PerformanceInterceptor performanceInterceptor() { PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor(); //sql格式化 performanceInterceptor.setFormat(true); return performanceInterceptor; } } /** * 自定义异常类 * * @author Francis * @date 2019-07-05 16:30 */ @Data @EqualsAndHashCode(callSuper = true) public class CosyException extends RuntimeException { private int code; private String msg; public CosyException(CodeMsg codeMsg){ this.msg = codeMsg.getMsg(); this.code = codeMsg.getCode(); } } /** * 异常处理 * * @author Francis * @version 1.0 * @date 2019-07-05 14:48 */ @Slf4j @ControllerAdvice public class MyExceptionHandler { @ResponseBody @ExceptionHandler({CosyException.class}) public Map<String, Object> handleBaseException(final CosyException exception) { log.error("自定义异常:", exception); return BaseResult.ajaxReturn(exception.getCode(), exception.getMessage(), null); } }
入口函数:
@SpringBootApplication @EnableAutoConfiguration public class DemoApplication { public static void main(String[] args) { SpringApplication.run(DemoApplication.class, args); } }
7、开始测试:(测试数据请自行预先添加)
本章完
PS:有关mybatis-plus相关操作,参见其官网。如后续时间充足,或会列出一系列demo