springboot整合swagger接口文档&springboot整合mybatis |
您所在的位置：网站首页 › springbootmybatisplus多表增删改查 › springboot整合swagger接口文档&springboot整合mybatis |
springboot整合swagger接口文档&springboot整合mybatis
|
目录 1 .swagger2 1.1 什么是swagger2 1.2 为什么需要使用swagger2的api文档 1.3 如何使用swagger2 2.springboot整合mybatis-plus 2.1mp的简介 2.2如何使用 2.3CRUD操作 1 .swagger2 1.1 什么是swagger2编写和维护接口文档是每个程序员的职责，根据Swagger2可以快速帮助我们编写最新的API接口文档，再也不用担心开会前仍忙于整理各种资料了，间接提升了团队开发的沟通效率（它就是可以api接口，它可以对你书写的接口进行说明。并以文档的形式存在。） 1.2 为什么需要使用swagger2的api文档
(1)引用swagger的依赖 io.github.jianzhichun spring-boot-starter-swagger2 0.0.1 com.github.xiaoymin swagger-bootstrap-ui 1.9.6 (2)配置swagger的信息 @Configuration public class SwaggerConfig { @Bean public Docket docket(){ Docket docket = new Docket(DocumentationType.SWAGGER_2) .groupName("qy165") .apiInfo(getInfo()) .select() //只为com.aaa.controller包下的类生成接口文档 .apis(RequestHandlerSelectors.basePackage("com.aaa.controller")) .build(); return docket; } private ApiInfo getInfo(){ Contact DEFAULT_CONTACT = new Contact("邵一凡", "http://www.jd.com", "[email protected]"); ApiInfo apiInfo = new ApiInfo("学生管理系统API文档", "学生管理系统API文档", "1.5", "localhost:8081/doc.html", DEFAULT_CONTACT, "AAA志远网络有限公司", "http://www.aaa.com"); return apiInfo; } }启动工程并访问swagger接口文档的路径 http://ip:port/swagger-ui.html
http://ip:port/doc.html
(3)使用swagger的注解。 @Api(tags="") : 加在接口Controller类上,它是对接口类的说明 @ApiOperation(value=""):加在接口方法上，他是对接口方法的说明 @ApiImplicitParams: 他是对接口所有参数的说明----body参数类型 @ApiImplicitParam：它是对单个参数的说明 @ApiModel: 它是对实体类的说明 @ApiModelProperty: 它是对实体类中属性的说明 2.springboot整合mybatis-plus 2.1mp的简介MyBatis-Plus (opens new window)（简称 MP）是一个 MyBatis (opens new window)的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。 愿景： 我们的愿景是成为 MyBatis 最好的搭档，就像 魂斗罗 中的 1P、2P，基友搭配，效率翻倍
特征： 无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑 损耗小：启动即会自动注入基本 CURD，性能基本无损耗，直接面向对象操作 强大的 CRUD 操作：内置通用 Mapper、通用 Service，仅仅通过少量配置即可实现==单表大部分 CRUD 操作==，更有强大的==条件构造器==，满足各类使用需求 支持 Lambda 形式调用：通过 Lambda 表达式，方便的编写各类查询条件，无需再担心字段写错 支持主键自动生成：支持多达 4 种主键策略（内含分布式唯一 ID 生成器 - Sequence），可自由配置，完美解决主键问题 支持 ActiveRecord 模式：支持 ActiveRecord 形式调用，实体类只需继承 Model 类即可进行强大的 CRUD 操作 支持自定义全局通用操作：支持全局通用方法注入（ Write once, use anywhere ） 内置代码生成器：采用代码或者 Maven 插件可快速生成 Mapper 、 Model 、 Service 、 Controller 层代码，支持模板引擎，更有超多自定义配置等您来使用 内置分页插件：基于 MyBatis 物理分页，开发者无需关心具体操作，配置好插件之后，写分页等同于普通 List 查询. 分页插件支持多种数据库：支持 MySQL[阿里巴巴]、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer 等多种数据库 内置性能分析插件：可输出 SQL 语句以及其执行时间，建议开发测试时启用该功能，能快速揪出慢查询 内置全局拦截插件：提供全表 delete 、 update 操作智能分析阻断，也可自定义拦截规则，预防误操作 2.2如何使用（1）依赖 com.baomidou mybatis-plus-boot-starter 3.3.2 org.springframework.boot spring-boot-starter-web mysql mysql-connector-java org.projectlombok lombok true org.springframework.boot spring-boot-starter-test test (2)配置文件 #数据源信息 spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver # characterEncoding防止您添加到数据的数据出现乱码。 spring.datasource.url=jdbc:mysql://localhost:3306/qy165?serverTimezone=Asia/Shanghai&characterEncoding=UTF8 spring.datasource.username=root spring.datasource.password=root #指定映射文件的路径--链表操作 mybatis-plus.mapper-locations=classpath:/mapper/*.xml #sql日志 mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl(3) 表的实体类 User @Data public class User { private Integer id; private String name; private Integer age; private String email; }(4)表的Dao接口 UserDao @Mapper public interface UserDao extends BaseMapper { }(5)单元测试 @Autowired private UserDao userDao; @Test void testById() { User user = userDao.selectById(1); System.out.println(user); }注意： 如果实体类和表名不一致，以及属性名和列名不一致，主键属性和列名不一致
（1）添加操作 @Test void testSave(){ User user=new User(); user.setUsername("陈重豪"); user.setAge(15); user.setEmail("[email protected]"); int insert = userDao.insert(user); System.out.println("影响的行数:"+insert); }发现: mp会自动为主键生成值，默认按照雪花算法【得到的值100%不会重复】。能否修改主键的生成策略.---能---如果想使用主键自增必须要求数据库中表的主键是递增模式。 /** * AUTO(0),递增 按照数据库表的主键递增模式 * NONE(1),人为输入id值 * INPUT(2),人为输入id值 * ASSIGN_ID(3),默认的算法。雪花算法 * ASSIGN_UUID(4),按照UUID生成---字符串 */ @TableId(type = IdType.AUTO) (2)删除操作 @Test void testDelete(){ // int i = userDao.deleteById(1670635267880386564L);//根据主键删除 // System.out.println("删除影响的行数:"+i); //批量删除 // List ids= Arrays.asList(1,2,5,7,9); // int i = userDao.deleteBatchIds(ids); // System.out.println("删除影响的行数:"+i); UpdateWrapper wrapper=new UpdateWrapper();//修改的条件构造器。 wrapper.likeRight("name","霍"); //name='霍梦' wrapper.or(); //默认多个条件使用and连接。 如果想使用or 则调用or() wrapper.between("age",18,20); userDao.delete(wrapper);//Wrapper对象:它是条件构造器。 }（3）修改操作 @Test void testUpdate(){ User user = new User(); // user.setUid(5L); // user.setUsername("于海龙"); // user.setAge(22); // user.setEmail("[email protected]"); // int i = userDao.updateById(user); // System.out.println("影响得到行数："+i); UpdateWrapper userUpdateWrapper = new UpdateWrapper(); userUpdateWrapper.eq("id",5L); //等价于 where id = 5； userUpdateWrapper.set("name","于海"); userDao.update(null,userUpdateWrapper); }（4）查询操作 @Test void testById() { //根据id查询 // User user = userDao.selectById(1); //根据 id 集合查询多条数据 // List integers = Arrays.asList(1, 2, 5, 4); // int i = userDao.deleteBatchIds(Arrays.asList(1, 2, 5, 4)); // System.out.println(user); // key：条件对应的表列；value：条件对应的表值 // Map map = new HashMap(); // map.put("name", "于海龙"); // map.put("age", 22); // List users = userDao.selectByMap(map); // System.out.println("User = " + users); //查询数据总条数 // Integer integer = userDao.selectCount(null); // System.out.println("count="+integer); //根据条件查询所有数据 // 如果加 wrapper 表示条件查询，如果为 null，表示查询所有 // List users = userDao.selectList(null); // users.forEach(System.out::println); //根据条件查询所有数据，查询出来的为 List // 如果加 wrapper 表示条件查询，如果为 null，表示查询所有 List users = userDao.selectMaps(null); for (Map user : users) { System.out.println("User = " + user); } } |
【本文地址】