SpringBoot整合swagger接口文档&&mybatis-plus【mp】框架&&代码生成器

Java于

已于 2023-06-20 21:57:21 修改

阅读量355

点赞数

文章标签： mybatis spring boot java

于 2023-06-20 20:53:50 首次发布

本文链接：https://blog.csdn.net/yhl15736773842/article/details/131287001

版权

1.springboot整合swagger接口文档

1.1 什么是swagger2

它就是可以api接口，它可以对你书写的接口进行说明。并以文档的形式存在。

1.2 为什么需要使用swagger2的api文档

1.3 如何使用swagger2

(1)引用swagger的依赖 ------2.3.12.RELEASE这个版本的springboot

<!--swagger的依赖引入-->
        <dependency>
            <groupId>io.github.jianzhichun</groupId>
            <artifactId>spring-boot-starter-swagger2</artifactId>
            <version>0.0.1</version>
        </dependency>
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.9.6</version>
        </dependency>

(2)配置swagger的信息

@Configuration //表示类似与配置文件
public class SwaggerConfig {

    @Bean //加在方法上，表示吧方法的返回结果交于spring容器来管理该对象. 里面封装了接口文档的信息，
    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", "110@qq.com");
        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.1 mp的简介

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）依赖

<dependencies>
        <!--mp依赖-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.3.2</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

(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<User> {
}

(5)单元测试

@Autowired
    private UserDao userDao;
    @Test
    void testById() {
        User user = userDao.selectById(1);
        System.out.println(user);
    }

注意：

如果实体类和表名不一致，以及属性名和列名不一致，主键属性和列名不一致

@Data
@TableName(value = "tbl_user") //如果没有添加该注解默认实体类映射对应的表名
public class User {
    @TableId(value = "id") //标记该属性为表的主键列，属性名和主键列名映射
    private Integer uid;
    @TableField(value = "name")//让属性名和列名映射
    private String username;
    private Integer age;
    private String email;
}

4.3 CRUD操作

（1）添加操作

 @Test
    void testSave(){
         User user=new User();
         user.setUsername("陈重豪");
         user.setAge(15);
         user.setEmail("110@qq.com");

        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<Integer> ids= Arrays.asList(1,2,5,7,9);
//        int i = userDao.deleteBatchIds(ids);
//        System.out.println("删除影响的行数:"+i);

        UpdateWrapper<User> wrapper=new UpdateWrapper<>();//修改的条件构造器。
        wrapper.likeRight("name","霍"); //name='霍梦'
        wrapper.or(); //默认多个条件使用and连接。 如果想使用or 则调用or()
        wrapper.between("age",18,20);
        userDao.delete(wrapper);//Wrapper对象:它是条件构造器。
    }

(3)批量查询

@Test
    void testSelect(){
        //批量查询
//        List<Integer> ids=Arrays.asList(1,2,3,5,7,4);
//        List<User> users = userDao.selectBatchIds(ids);
//        System.out.println(users);
//        QueryWrapper<User> wrapper=new QueryWrapper<>();
//        wrapper.select("name","age"); //查询指定列的值
//        wrapper.orderByDesc("age");
//        //wrapper.groupBy("name"); //select 分组列,聚合函数  from 表名    group by 列
//        List<User> users = userDao.selectList(wrapper);//根据条件查询,如果传递的条件对象为null,则查询全部
//        System.out.println(users);
//        QueryWrapper<User> wrapper=new QueryWrapper<>();
//        wrapper.eq("name","张三");
//        User user = userDao.selectOne(wrapper);//根据条件查询一条记录。 登录 账号和密码
//        System.out.println(user);
        //配置分页拦截器。===== 
        IPage<User> page=new Page<>(2,3);
        IPage<User> page1 = userDao.selectPage(page, null);
        System.out.println("总条数:"+page1.getTotal());
        System.out.println("总页数:"+page1.getPages());
        System.out.println("当前页的记录:"+page1.getRecords());
    }

（4）不使用plus的sql，联表分页条件查询

3. 代码生成器

根据你创建好的表---生成实体类[swagger注解]---dao----service---xml

public class CodeGenerator {

    /**
     * <p>
     * 读取控制台内容
     * </p>
     */
    public static String scanner(String tip) {
        Scanner scanner = new Scanner(System.in);
        StringBuilder help = new StringBuilder();
        help.append("请输入" + tip + "：");
        System.out.println(help.toString());
        if (scanner.hasNext()) {
            String ipt = scanner.next();
            if (StringUtils.isNotBlank(ipt)) {
                return ipt;
            }
        }
        throw new MybatisPlusException("请输入正确的" + tip + "！");
    }

    public static void main(String[] args) {
        // 代码生成器
        AutoGenerator mpg = new AutoGenerator();

        // 全局配置
        GlobalConfig gc = new GlobalConfig();
        String projectPath = "D:\\IDEA-Projects\\qy165-springboot04";
        gc.setOutputDir(projectPath + "/src/main/java");
        gc.setAuthor("于海龙");
        gc.setOpen(false);
        gc.setSwagger2(true); //实体属性 Swagger2 注解
        mpg.setGlobalConfig(gc);

        // 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/tui_education?characterEncoding=utf8&serverTimezone=Asia/Shanghai");
        // dsc.setSchemaName("public");
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("root");
        mpg.setDataSource(dsc);

        // 包配置
        PackageConfig pc = new PackageConfig();
        pc.setModuleName("system");
        pc.setParent("com.aaa");
        mpg.setPackageInfo(pc);

        // 自定义配置
        InjectionConfig cfg = new InjectionConfig() {
            @Override
            public void initMap() {
                // to do nothing
            }
        };

        // 如果模板引擎是 freemarker
        String templatePath = "/templates/mapper.xml.ftl";
        // 如果模板引擎是 velocity
        // String templatePath = "/templates/mapper.xml.vm";

        // 自定义输出配置
        List<FileOutConfig> focList = new ArrayList<>();
        // 自定义配置会被优先输出
        focList.add(new FileOutConfig(templatePath) {
            @Override
            public String outputFile(TableInfo tableInfo) {
                // 自定义输出文件名 ， 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化！！
                return projectPath + "/src/main/resources/mapper/"
                        + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
            }
        });
        /*
        cfg.setFileCreate(new IFileCreate() {
            @Override
            public boolean isCreate(ConfigBuilder configBuilder, FileType fileType, String filePath) {
                // 判断自定义文件夹是否需要创建
                checkDir("调用默认方法创建的目录，自定义目录用");
                if (fileType == FileType.MAPPER) {
                    // 已经生成 mapper 文件判断存在，不想重新生成返回 false
                    return !new File(filePath).exists();
                }
                // 允许生成模板文件
                return true;
            }
        });
        */
        cfg.setFileOutConfigList(focList);
        mpg.setCfg(cfg);

        // 配置模板
        TemplateConfig templateConfig = new TemplateConfig();

        // 配置自定义输出模板
        //指定自定义模板路径，注意不要带上.ftl/.vm, 会根据使用的模板引擎自动识别
        // templateConfig.setEntity("templates/entity2.java");
        // templateConfig.setService();
        // templateConfig.setController();

        templateConfig.setXml(null);
        mpg.setTemplate(templateConfig);

        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        strategy.setEntityLombokModel(true);
        strategy.setRestControllerStyle(true);
        // 公共父类
        // 写于父类中的公共字段
        strategy.setInclude("acl_permission","acl_role","acl_role_permission","acl_user","acl_user_role");
        strategy.setControllerMappingHyphenStyle(true);
        strategy.setTablePrefix("acl_");
        mpg.setStrategy(strategy);
        mpg.setTemplateEngine(new FreemarkerTemplateEngine());
        mpg.execute();
    }

}

所需要的依赖

<dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!--mybatisPlus依赖-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.3.2</version>
        </dependency>
        <!--mp代码生成器依赖-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
            <version>3.3.2</version>
        </dependency>
        <dependency>
            <groupId>org.apache.velocity</groupId>
            <artifactId>velocity-engine-core</artifactId>
            <version>2.3</version>
        </dependency>
        <dependency>
            <groupId>org.freemarker</groupId>
            <artifactId>freemarker</artifactId>
            <version>2.3.29</version>
        </dependency>

        <!--swagger依赖-->
        <dependency>
            <groupId>io.github.jianzhichun</groupId>
            <artifactId>spring-boot-starter-swagger2</artifactId>
            <version>0.0.1</version>
        </dependency>
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.9.6</version>
        </dependency>

        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>