源代码

一、项目配置

1、项目yml

  1. server:
  2.   port: 9188
  3. spring:
  4.   application:
  5.     name: git-test3
  6.   datasource:
  7.     driver-class-name: com.mysql.cj.jdbc.Driver
  8.     url: jdbc:mysql://x.x.x.x:3306/mytest?serverTimezone=UTC&useSSL=false
  9.     username: azhi
  10.     password: azhi2021888

2、项目pom.xml

  1.     <parent>
  2.         <groupId>org.springframework.boot</groupId>
  3.         <artifactId>spring-boot-starter-parent</artifactId>
  4.         <version>2.3.9.RELEASE</version>
  5.     </parent>
  7.     <dependencies>
  8.         <!--spring-boot-->
  9.         <dependency>
  10.             <groupId>org.springframework.boot</groupId>
  11.             <artifactId>spring-boot-starter</artifactId>
  12.         </dependency>
  13.         <dependency>
  14.             <groupId>org.springframework.boot</groupId>
  15.             <artifactId>spring-boot-starter-web</artifactId>
  16.         </dependency>
  18.         <!--mysql相关依赖-->
  19.         <dependency>
  20.             <groupId>org.springframework.boot</groupId>
  21.             <artifactId>spring-boot-starter-jdbc</artifactId>
  22.             <version>2.3.9.RELEASE</version>
  23.         </dependency>
  24.         <dependency>
  25.             <groupId>mysql</groupId>
  26.             <artifactId>mysql-connector-java</artifactId>
  27.             <version>8.0.26</version>
  28.         </dependency>
  30.         <!--mybatis-plus依赖,如果冲突,这里就用3.4.1版本,和mybatis-plus-generator一致-->
  31.         <dependency>
  32.             <groupId>com.baomidou</groupId>
  33.             <artifactId>mybatis-plus-boot-starter</artifactId>
  34.             <version>3.4.3.4</version>
  35.         </dependency>
  37.         <!--generator代码生成依赖,要注意mybatis-plus和generator的版本比较容易冲突-->
  38.         <dependency>
  39.             <groupId>com.baomidou</groupId>
  40.             <artifactId>mybatis-plus-generator</artifactId>
  41.             <version>3.4.1</version>
  42.         </dependency>
  44.         <!--freemarker代码生成模板依赖-->
  45.         <dependency>
  46.             <groupId>org.freemarker</groupId>
  47.             <artifactId>freemarker</artifactId>
  48.             <version>2.3.31</version>
  49.         </dependency>
  51.         <!--entity中Data依赖-->
  52.         <dependency>
  53.             <groupId>org.projectlombok</groupId>
  54.             <artifactId>lombok</artifactId>
  55.             <version>1.18.20</version>
  56.         </dependency>
  58.         <!--swagger3-->
  59.         <dependency>
  60.             <groupId>io.springfox</groupId>
  61.             <artifactId>springfox-boot-starter</artifactId>
  62.             <version>3.0.0</version>
  63.         </dependency>
  65.         <!--swagger-bootstrap-ui-->
  66.         <dependency>
  67.             <groupId>com.github.xiaoymin</groupId>
  68.             <artifactId>swagger-bootstrap-ui</artifactId>
  69.             <version>1.9.6</version>
  70.         </dependency>
  71.     </dependencies>
  73.     <build>
  74.         <finalName>${project.artifactId}</finalName>
  75.         <plugins>
  76.             <plugin>
  77.                 <groupId>org.springframework.boot</groupId>
  78.                 <artifactId>spring-boot-maven-plugin</artifactId>
  79.             </plugin>
  80.         </plugins>
  81.     </build>

3、Generator自动代码生成类：

  1. import com.baomidou.mybatisplus.core.toolkit.StringPool;
  2. import com.baomidou.mybatisplus.generator.AutoGenerator;
  3. import com.baomidou.mybatisplus.generator.InjectionConfig;
  4. import com.baomidou.mybatisplus.generator.config.*;
  5. import com.baomidou.mybatisplus.generator.config.po.TableInfo;
  6. import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
  7. import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
  8. import java.util.ArrayList;
  9. import java.util.List;
  10. public class CodeGenerator {
  11.     private static String[] tables = new String[]{"user","order"};
  12.     public static void main(String[] args) {
  13.         // 代码生成器
  14.         AutoGenerator mpg = new AutoGenerator();
  16.         // 全局配置
  17.         GlobalConfig gc = new GlobalConfig();
  18.         String projectPath = System.getProperty("user.dir");
  19.         gc.setOutputDir(projectPath + "/src/main/java");
  20.         gc.setAuthor("azhi");
  21.         gc.setOpen(false);
  22.         gc.setSwagger2(true);     //entity实体属性添加Swagger2注解ApiModel
  23.         mpg.setGlobalConfig(gc);
  25.         // 数据源配置
  26.         DataSourceConfig dsc = new DataSourceConfig();
  27.         dsc.setUrl("jdbc:mysql://x.x.x.x:3306/mytest?serverTimezone=UTC&useSSL=false");
  28.         // dsc.setSchemaName("public");
  29.         dsc.setDriverName("com.mysql.cj.jdbc.Driver");
  30.         dsc.setUsername("azhi");
  31.         dsc.setPassword("azhi2021888");
  32.         mpg.setDataSource(dsc);
  34.         // 包配置
  35.         PackageConfig pc = new PackageConfig();
  36.         pc.setParent("com.azhi.gitTest3");
  37.         mpg.setPackageInfo(pc);
  39.         // 自定义配置
  40.         InjectionConfig cfg = new InjectionConfig() {
  41.             @Override
  42.             public void initMap() {
  43.                 // to do nothing
  44.             }
  45.         };
  47.         // 如果模板引擎是 freemarker
  48.         String templatePath = "/templates/mapper.xml.ftl";
  49.         // 如果模板引擎是 velocity
  50.         // String templatePath = "/templates/mapper.xml.vm";
  52.         // 自定义输出配置
  53.         List<FileOutConfig> focList = new ArrayList<>();
  54.         // 自定义配置会被优先输出
  55.         focList.add(new FileOutConfig(templatePath) {
  56.             @Override
  57.             public String outputFile(TableInfo tableInfo) {
  58.                 // 自定义输出文件名 ， 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化！！
  59.                 return projectPath + "/src/main/resources/mapper/"
  60. //                        + pc.getModuleName()
  61.                         + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
  62.             }
  63.         });
  64.         /*
  65.         cfg.setFileCreate(new IFileCreate() {
  66.             @Override
  67.             public boolean isCreate(ConfigBuilder configBuilder, FileType fileType, String filePath) {
  68.                 // 判断自定义文件夹是否需要创建
  69.                 checkDir("调用默认方法创建的目录");
  70.                 return false;
  71.             }
  72.         });
  73.         */
  74.         cfg.setFileOutConfigList(focList);
  75.         mpg.setCfg(cfg);
  77.         // 配置模板
  78.         TemplateConfig templateConfig = new TemplateConfig();
  80.         // 配置自定义输出模板
  81.         //指定自定义模板路径，注意不要带上.ftl/.vm, 会根据使用的模板引擎自动识别
  82.         // templateConfig.setEntity("templates/entity2.java");
  83.         // templateConfig.setService();
  84.         // templateConfig.setController();
  86.         templateConfig.setXml(null);
  87.         mpg.setTemplate(templateConfig);
  89.         // 策略配置
  90.         StrategyConfig strategy = new StrategyConfig();
  91.         strategy.setNaming(NamingStrategy.underline_to_camel);
  92.         strategy.setColumnNaming(NamingStrategy.underline_to_camel);
  93. //        strategy.setSuperEntityClass("你自己的父类实体,没有就不用设置!");
  94.         strategy.setEntityLombokModel(true);
  95.         strategy.setRestControllerStyle(true);
  96.         // 公共父类
  97. //        strategy.setSuperControllerClass("com.snow.management.controller.BaseController");//你自己的父类控制器,没有就不用设置!
  98.         // 写于父类中的公共字段
  99. //        strategy.setSuperEntityColumns("id");//生成的实体类没有id字段
  100. //        strategy.setInclude(scanner("表名，多个英文逗号分割").split(","));
  101.         strategy.setInclude(tables);
  102.         strategy.setControllerMappingHyphenStyle(true);
  103. //        strategy.setTablePrefix(pc.getModuleName() + "_");
  104.         mpg.setStrategy(strategy);
  105.         mpg.setTemplateEngine(new FreemarkerTemplateEngine());
  106.         mpg.execute();
  107.     }
  108. }

4、swagger3配置类

  1. import io.swagger.annotations.ApiOperation;
  2. import org.springframework.context.annotation.Bean;
  3. import org.springframework.context.annotation.Configuration;
  4. import springfox.documentation.builders.ApiInfoBuilder;
  5. import springfox.documentation.builders.PathSelectors;
  6. import springfox.documentation.builders.RequestHandlerSelectors;
  7. import springfox.documentation.oas.annotations.EnableOpenApi;
  8. import springfox.documentation.service.ApiInfo;
  9. import springfox.documentation.service.Contact;
  10. import springfox.documentation.spi.DocumentationType;
  11. import springfox.documentation.spring.web.plugins.Docket;
  12. @EnableOpenApi
  13. @Configuration
  14. public class SwaggerConfig {
  15.     @Bean
  16.     public Docket createRestApi() {
  17.         //swagger设置，基本信息，要解析的接口及路径等
  18.         return new Docket(DocumentationType.OAS_30)
  19.                 .apiInfo(apiInfo())
  20.                 .select()
  21.                 //设置通过什么方式定位需要自动生成文档的接口，这里定位方法上的@ApiOperation注解
  22.                 .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
  23.                 //接口URI路径设置，any是全路径，也可以通过PathSelectors.regex()正则匹配
  24.                 .paths(PathSelectors.any())
  25.                 .build();
  26.     }
  27.     //生成接口信息，包括标题、联系人，联系方式等
  28.     private ApiInfo apiInfo() {
  29.         return new ApiInfoBuilder()
  30.                 .title("Swagger3接口文档")
  31.                 .description("如有疑问，请联系开发工程师")
  32.                 .contact(new Contact("denglinzhi", "https://www.yuque.com/docs/share/3994dcb3-4358-4c02-9d9b-510d4877f601", "913240792@qq.com"))
  33.                 .version("1.0")
  34.                 .build();
  35.     }
  36. }
  1. import lombok.extern.slf4j.Slf4j;
  2. import org.springframework.boot.web.context.WebServerInitializedEvent;
  3. import org.springframework.context.ApplicationListener;
  4. import org.springframework.stereotype.Component;
  5. import java.net.Inet4Address;
  6. import java.net.UnknownHostException;
  7. /**
  8.  * @Description 控制台输出 Swagger3 接口文档地址
  9.  **/
  10. @Component
  11. @Slf4j
  12. public class SwaggerPrintConfig implements ApplicationListener<WebServerInitializedEvent> {
  13.     @Override
  14.     public void onApplicationEvent(WebServerInitializedEvent event) {
  15.         try {
  16.             //获取IP
  17.             String hostAddress = Inet4Address.getLocalHost().getHostAddress();
  18.             //获取端口号
  19.             int port = event.getWebServer().getPort();
  20.             //获取应用名
  21.             String applicationName = event.getApplicationContext().getApplicationName();
  22.             //log.info("项目启动启动成功！Swagger3接口文档地址: http://"+hostAddress+":"+event.getWebServer().getPort()+applicationName+"/swagger-ui/index.html");
  23.             log.info("项目启动启动成功！Swagger3接口文档地址: http://"+hostAddress+":"+event.getWebServer().getPort()+applicationName+"/doc.html");
  24.         } catch (UnknownHostException e) {
  25.             e.printStackTrace();
  26.         }
  27.     }
  28. }

5、mybatiesplus分页配置类

  1. import com.baomidou.mybatisplus.annotation.DbType;
  2. import com.baomidou.mybatisplus.autoconfigure.ConfigurationCustomizer;
  3. import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
  4. import com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor;
  5. import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
  6. import org.springframework.context.annotation.Bean;
  7. import org.springframework.context.annotation.Configuration;
  8. import org.springframework.transaction.annotation.EnableTransactionManagement;
  9. //Spring boot方式
  10. @EnableTransactionManagement
  11. @Configuration
  12. public class MybatisPlusConfig {
  13.     /**
  14.      * 旧版本配置,分页插件
  15.      *
  16.      */
  17.     /*@Bean
  18.     public PaginationInterceptor paginationInterceptor(){
  19.         return new PaginationInterceptor();
  20.     }*/
  21.     /**
  22.      * 新的分页插件,一缓和二缓遵循mybatis的规则,
  23.      * 需要设置 MybatisConfiguration#useDeprecatedExecutor = false
  24.      * 避免缓存出现问题(该属性会在旧插件移除后一同移除)
  25.      */
  26.     @Bean
  27.     public MybatisPlusInterceptor mybatisPlusInterceptor() {
  28.         MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
  29.         interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.H2));
  30.         return interceptor;
  31.     }
  32.     @Bean
  33.     public ConfigurationCustomizer configurationCustomizer() {
  34.         return configuration -> configuration.setUseDeprecatedExecutor(false);
  35.     }
  36. }

二、进行CURD测试

1、写user实体类

  1. import com.baomidou.mybatisplus.annotation.IdType;
  2. import com.baomidou.mybatisplus.annotation.TableId;
  3. import java.io.Serializable;
  4. import io.swagger.annotations.ApiModel;
  5. import io.swagger.annotations.ApiModelProperty;
  6. import lombok.Data;
  7. import lombok.EqualsAndHashCode;
  8. /**
  9.  * @author azhi
  10.  * @since 2021-11-28
  11.  */
  12. @Data
  13. @EqualsAndHashCode(callSuper = false)
  14. @ApiModel(value="User对象", description="")
  15. public class User implements Serializable {
  17.     @ApiModelProperty(value = "自增id", example = "", required = true)
  18.     private static final long serialVersionUID = 1L;
  20.     @ApiModelProperty(value = "自增id", example = "", required = true)
  21.     @TableId(value = "id", type = IdType.AUTO)
  22.     private Integer id;
  24.     @ApiModelProperty(value = "用户名称", example = "", required = true)
  25.     private String name;
  26. }

2、写xml mapper

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
  3. <mapper namespace="com.azhi.gitTest3.mapper.UserMapper">
  5.     <select id="selectAllUser" parameterType="int" resultType="com.azhi.gitTest3.entity.User">
  6.         select id,name from user
  7.     </select>
  9.     <select id="selectUserByUserId" parameterType="int" resultType="com.azhi.gitTest3.entity.User">
  10.         select id,name from user where id = #{user_id}
  11.     </select>
  13.     <select id="selectUserByPage" resultType="com.azhi.gitTest3.entity.User">
  14.         select id,name from user ${ew.customSqlSegment}
  15.     </select>
  17.     <select id="selectUserByPage1" resultType="com.azhi.gitTest3.entity.User" parameterType="com.azhi.gitTest3.entity.User">
  18.         select id,name from user
  19.         <where>
  20.             <if test="et.id != null ">and id = #{et.id}</if>
  21.             <if test="et.name != null ">and name = #{et.name}</if>
  22.         </where>
  23.     </select>
  25.     <insert id="addUserBatch" parameterType="com.azhi.gitTest3.entity.User">
  26.         insert into user (id,name) values
  27.         <foreach collection="listUser" item="user" separator=",">
  28.             (#{user.id},#{user.name})
  29.         </foreach>
  30.     </insert>
  31. </mapper>

3、映射xml mapper

  1. import com.azhi.gitTest3.entity.User;
  2. import com.baomidou.mybatisplus.core.conditions.Wrapper;
  3. import com.baomidou.mybatisplus.core.mapper.BaseMapper;
  4. import com.baomidou.mybatisplus.core.metadata.IPage;
  5. import com.baomidou.mybatisplus.core.toolkit.Constants;
  6. import org.apache.ibatis.annotations.Param;
  7. import org.springframework.stereotype.Service;
  8. import java.util.List;
  9. /**
  10.  * @author azhi
  11.  * @since 2021-11-28
  12.  */
  13. @Service
  14. public interface UserMapper extends BaseMapper<User> {
  15.     List<User> selectAllUser();
  16.     User selectUserByUserId(int user_id);
  17.     IPage<User> selectUserByPage(IPage<User> userPage , @Param(Constants.WRAPPER) Wrapper<User> userWrapper);
  18.     IPage<User> selectUserByPage1(IPage<User> userPage , @Param(Constants.ENTITY) User user);
  19.     int addUserBatch(@Param("listUser")List<User> listUser);
  20. }

4、写IUserService

  1. import com.azhi.gitTest3.entity.User;
  2. import com.baomidou.mybatisplus.core.conditions.Wrapper;
  3. import com.baomidou.mybatisplus.core.metadata.IPage;
  4. import com.baomidou.mybatisplus.core.toolkit.Constants;
  5. import com.baomidou.mybatisplus.extension.service.IService;
  6. import org.apache.ibatis.annotations.Param;
  7. import java.util.List;
  9. /**
  10.  * @author azhi
  11.  * @since 2021-11-28
  12.  */
  13. public interface IUserService extends IService<User> {
  14.     List<User> selectAllUser();
  15.     User selectUserByUserId(int user_id);
  16.     IPage<User> selectUserByPage(IPage<User> userPage , @Param(Constants.WRAPPER) Wrapper<User> userWrapper);
  17.     IPage<User> selectUserByPage1(IPage<User> userPage , @Param(Constants.ENTITY) User user);
  18.     int addUserBatch(@Param("listUser")List<User> listUser);
  19. }

5、写UserServiceImpl

  1. import com.azhi.gitTest3.entity.User;
  2. import com.azhi.gitTest3.mapper.UserMapper;
  3. import com.azhi.gitTest3.service.IUserService;
  4. import com.baomidou.mybatisplus.core.conditions.Wrapper;
  5. import com.baomidou.mybatisplus.core.metadata.IPage;
  6. import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
  7. import org.springframework.beans.factory.annotation.Autowired;
  8. import org.springframework.stereotype.Service;
  9. import java.util.List;
  10. /**
  11.  * @author azhi
  12.  * @since 2021-11-28
  13.  */
  14. @Service
  15. public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements IUserService {
  17.     @Autowired
  18.     UserMapper userMapper;
  20.     @Override
  21.     public List<User> selectAllUser() {
  22.         return userMapper.selectAllUser();
  23.     }
  25.     @Override
  26.     public User selectUserByUserId(int user_id) {
  27.         return userMapper.selectUserByUserId(user_id);
  28.     }
  30.     @Override
  31.     public IPage<User> selectUserByPage(IPage<User> userPage, Wrapper<User> userWrapper) {
  32.         return userMapper.selectUserByPage(userPage, userWrapper);
  33.     }
  35.     @Override
  36.     public IPage<User> selectUserByPage1(IPage<User> userPage, User user) {
  37.         return userMapper.selectUserByPage1(userPage, user);
  38.     }
  40.     @Override
  41.     public int addUserBatch(List<User> listUser) {
  42.         return userMapper.addUserBatch(listUser);
  43.     }
  44. }

6、controller中调用

  1. import com.azhi.gitTest3.entity.User;
  2. import com.azhi.gitTest3.service.IUserService;
  3. import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
  4. import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
  5. import com.baomidou.mybatisplus.core.metadata.IPage;
  6. import com.baomidou.mybatisplus.core.toolkit.Wrappers;
  7. import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
  8. import io.swagger.annotations.Api;
  9. import io.swagger.annotations.ApiOperation;
  10. import org.springframework.beans.factory.annotation.Autowired;
  11. import org.springframework.web.bind.annotation.GetMapping;
  12. import org.springframework.web.bind.annotation.RequestMapping;
  13. import org.springframework.web.bind.annotation.RestController;
  14. import java.util.ArrayList;
  15. import java.util.List;
  17. /**
  18.  * @author azhi
  19.  * @since 2021-11-28
  20.  */
  21. @RestController
  22. @RequestMapping("/user")
  23. @Api(tags = "测试用户控制类")
  24. public class UserController {
  26.     @Autowired
  27.     private IUserService userService;
  29.     @GetMapping("/login")
  30.     @ApiOperation(value = "测试login方法")
  31.     public User login() {
  32.         System.out.println("ok");
  33.         User user = userService.selectUserByUserId(1);
  34.         return user;
  35.     }
  37.     @GetMapping("/all")
  38.     @ApiOperation(value = "测试all方法")
  39.     public List<User> all() {
  40.         System.out.println("ok");
  41.         List<User> users = userService.selectAllUser();
  42.         return users;
  43.     }
  45.     @GetMapping("/page")
  46.     @ApiOperation(value = "测试page分页方法")
  47.     public IPage<User> page() {
  48.         System.out.println("ok");
  49.         Integer pageNo = 1;
  50.         Integer pageSize = 10;
  51.         IPage<User> page = new Page<>(pageNo, pageSize,true);
  52.         QueryWrapper<User> wrapper = new QueryWrapper<>();
  53.         User user = new User();
  54.         user.setId(1);
  55.         wrapper.setEntity(user);
  56.         //IPage<User> result = userService.page(page,null);
  57.         IPage<User> result = userService.page(page,wrapper);
  58.         return result;
  59.     }
  61.     @GetMapping("/xmlPage")
  62.     @ApiOperation(value = "测试xmlPage分页方法")
  63.     public IPage<User> xmlPage() {
  64.         LambdaQueryWrapper<User> userLambdaQueryWrapper = Wrappers.lambdaQuery();
  65.         userLambdaQueryWrapper.like(User::getId , 1);
  67.         Page<User> page = new Page<>(1 , 2 , true);
  68.         IPage<User> mapIPage = userService.selectUserByPage(page , userLambdaQueryWrapper);
  69.         return mapIPage;
  70.     }
  72.     @GetMapping("/xmlPage1")
  73.     @ApiOperation(value = "测试xmlPage1分页方法")
  74.     public IPage<User> xmlPage1() {
  75.         Page<User> page = new Page<>(1 , 2 , true);
  76.         User user = new User();
  77.         user.setId(1);
  78.         IPage<User> mapIPage = userService.selectUserByPage1(page , user);
  79.         return mapIPage;
  80.     }
  82.     @GetMapping("/addBatch")
  83.     @ApiOperation(value = "测试addBatch批量添加用户方法")
  84.     public int addBatch() {
  85.         List<User> list = new ArrayList<>();
  86.         for(int id = 3;id<6;id++){
  87.             User user = new User();
  88.             user.setId(id);
  89.             user.setName(id+"");
  90.             list.add(user);
  91.         }
  92.         int count = userService.addUserBatch(list);
  93.         return count;
  94.     }
  95. }

三、测试文档

image.png
image.png
也可以用doc文档，http://192.168.1.8:9522/doc.html，如下：
image.png