搭建环境IDEA下的springboot+mybatis-plus+mysql+swagger2后台+rest风格 入门

一、新建工程
随意创建
1.1
在这里插入图片描述
二、引入Maven坐标

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.3.0.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.example</groupId>
    <artifactId>demo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>demo</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
        <!-- 引入mybatis jsd-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatisplus-spring-boot-starter</artifactId>
            <version>1.0.5</version>
        </dependency>
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>1.3.2</version>
        </dependency>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus</artifactId>
            <version>2.1.4</version>
        </dependency>
        <!-- 代码生成器使用模板引擎 -->
        <dependency>
            <groupId>org.apache.velocity</groupId>
            <artifactId>velocity-engine-core</artifactId>
            <version>2.0</version>
        </dependency>
        <!-- 连接池 -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
            <version>1.0.29</version>
        </dependency>
        <!-- swagger依赖 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.6.1</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.6.1</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

三、配置application.yml

server:
  port: 8080
spring:
  resources:
    static-locations: classpath:/resources/
  datasource:
    # 数据库配置
    type: com.alibaba.druid.pool.DruidDataSource
    url: jdbc:mysql://127.0.0.1:3306/test?serverTimezone=UTC&characterEncoding=utf-8&useSSL=false
    username: root
    password: root
    driverClassName: com.mysql.jdbc.Driver

#mybatis
mybatis-plus:
  mapper-locations: classpath:/mapper/*Mapper.xml
  #实体扫描,多个package用逗号或者分号分隔
  typeAliasesPackage: com.tc.entity
  #typeEnumsPackage: com.broker.entity.enums
  global-config:
    #主键类型  0:"数据库ID自增", 1:"用户输入ID",2:"全局唯一ID (数字类型唯一ID)", 3:"全局唯一ID UUID";
    id-type: 0
    #字段策略 0:"忽略判断",1:"非 NULL 判断"),2:"非空判断"
    field-strategy: 2
    #驼峰下划线转换
    db-column-underline: true
    #刷新mapper 调试神器
    refresh-mapper: true

四、修改DemoApplication

package com.tc;

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
@MapperScan("com.tc.dao")
public class DemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }

}

五、编写逆向生成文件 Util/MysqlGenerator.java

注意修改要生成的表名字
private static String table = “user”; //table名字
在这里插入图片描述

package util;

import com.baomidou.mybatisplus.enums.FieldFill;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.InjectionConfig;
import com.baomidou.mybatisplus.generator.config.*;
import com.baomidou.mybatisplus.generator.config.converts.MySqlTypeConvert;
import com.baomidou.mybatisplus.generator.config.po.TableFill;
import com.baomidou.mybatisplus.generator.config.po.TableInfo;
import com.baomidou.mybatisplus.generator.config.rules.DbColumnType;
import com.baomidou.mybatisplus.generator.config.rules.DbType;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;

import java.util.*;

public class MysqlGenerator {
  private static String table = "user";            //table名字
  private static String[] prefixs = {"t_","m_"};            //table前缀
  private static String authorName = "tc";                //作者
  private static String parent = "com.tc";         //父包名
  private static String path = System.getProperty("user.dir");
  private static String url = "jdbc:mysql://127.0.0.1:3306/test?serverTimezone=UTC&characterEncoding=utf8";
  private static String username = "root";
  private static String password = "root";
  private static String driverClassName = "com.mysql.jdbc.Driver";

  public static void main(String[] args) {
    // 自定义需要填充的字段
    List<TableFill> tableFillList = new ArrayList<>();
//    tableFillList.add(new TableFill("ASDD_SS", FieldFill.INSERT_UPDATE));
    // 代码生成器
    AutoGenerator mpg = new AutoGenerator().setGlobalConfig(
            // 全局配置
            new GlobalConfig()
                    .setOutputDir(path+"/src/main/java")//输出目录
                    .setFileOverride(true)// 是否覆盖文件
                    .setActiveRecord(true)// 开启 activeRecord 模式
                    .setEnableCache(false)// XML 二级缓存
                    .setBaseResultMap(true)// XML ResultMap
                    .setBaseColumnList(true)// XML columList
                    .setOpen(false)//生成后打开文件夹
                    .setAuthor(authorName)
                    // 自定义文件命名,注意 %s 会自动填充表实体属性!
                    .setMapperName("%sDao")
                    .setXmlName("%sMapper")
                    .setServiceName("%sService")
                    .setServiceImplName("%sServiceImpl")
                    .setControllerName("%sController")
    ).setDataSource(
            // 数据源配置
            new DataSourceConfig()
                    .setDbType(DbType.MYSQL)// 数据库类型
                    .setTypeConvert(new MySqlTypeConvert() {
                      // 自定义数据库表字段类型转换【可选】
                      @Override
                      public DbColumnType processTypeConvert(String fieldType) {
                        System.out.println("转换类型:" + fieldType);
                        // if ( fieldType.toLowerCase().contains( "tinyint" ) ) {
                        //    return DbColumnType.BOOLEAN;
                        // }
                        return super.processTypeConvert(fieldType);
                      }
                    })
                    .setDriverName(driverClassName)
                    .setUsername(username)
                    .setPassword(password)
                    .setUrl(url)
    ).setStrategy(
            // 策略配置
            new StrategyConfig()
                    // .setCapitalMode(true)// 全局大写命名
                    .setDbColumnUnderline(true)//全局下划线命名
//                    .setTablePrefix(prefixs)// 此处可以修改为您的表前缀
                    .setNaming(NamingStrategy.underline_to_camel)// 表名生成策略
                    .setInclude(new String[] { table }) // 需要生成的表
                    .setRestControllerStyle(true)
                    //.setExclude(new String[]{"test"}) // 排除生成的表
                    // 自定义实体父类
                    // .setSuperEntityClass("com.baomidou.demo.TestEntity")
                    // 自定义实体,公共字段
                    //.setSuperEntityColumns(new String[]{"test_id"})
                    .setTableFillList(tableFillList)
                    // 自定义 mapper 父类
                    // .setSuperMapperClass("com.baomidou.demo.TestMapper")
                    // 自定义 service 父类
                    // .setSuperServiceClass("com.baomidou.demo.TestService")
                    // 自定义 service 实现类父类
                    // .setSuperServiceImplClass("com.baomidou.demo.TestServiceImpl")
                    // 自定义 controller 父类
                    //.setSuperControllerClass("com.broker.controller.AbstractController")
                    // 【实体】是否生成字段常量(默认 false)
                    // public static final String ID = "test_id";
                    .setEntityColumnConstant(true)
            // 【实体】是否为构建者模型(默认 false)
            // public User setName(String name) {this.name = name; return this;}
            // .setEntityBuilderModel(true)
            // 【实体】是否为lombok模型(默认 false)<a href="https://projectlombok.org/">document</a>
            // .setEntityLombokModel(true)
            // Boolean类型字段是否移除is前缀处理
            // .setEntityBooleanColumnRemoveIsPrefix(true)
            // .setRestControllerStyle(true)
            // .setControllerMappingHyphenStyle(true)
    ).setPackageInfo(
            // 包配置
            new PackageConfig()
                    //.setModuleName("User")
                    .setParent(parent)// 自定义包路径
                    .setController("controller")// 这里是控制器包名,默认 web
                    .setEntity("entity")
                    .setMapper("dao")
                    .setService("service")
                    .setServiceImpl("service.impl")
            //.setXml("mapper")
    ).setCfg(
            // 注入自定义配置,可以在 VM 中使用 cfg.abc 设置的值
            new InjectionConfig() {
              @Override
              public void initMap() {
                Map<String, Object> map = new HashMap<>();
                map.put("abc", this.getConfig().getGlobalConfig().getAuthor() + "-mp");
                this.setMap(map);
              }
            }.setFileOutConfigList(Collections.<FileOutConfig>singletonList(new FileOutConfig("/templates/mapper.xml.vm") {
              // 自定义输出文件目录
              @Override
              public String outputFile(TableInfo tableInfo) {
                return path+"/src/main/resources/mapper/" + tableInfo.getEntityName() + "Mapper.xml";
              }
            }))
    ).setTemplate(
            // 关闭默认 xml 生成,调整生成 至 根目录
            new TemplateConfig().setXml(null)
            // 自定义模板配置,模板可以参考源码 /mybatis-plus/src/main/resources/template 使用 copy
            // 至您项目 src/main/resources/template 目录下,模板名称也可自定义如下配置:
            // .setController("...");
            // .setEntity("...");
            // .setMapper("...");
            // .setXml("...");
            // .setService("...");
            // .setServiceImpl("...");
    );

    // 执行生成
    mpg.execute();

    // 打印注入设置,这里演示模板里面怎么获取注入内容【可无】
    System.err.println(mpg.getCfg().getMap().get("abc"));
  }
}

结构目录
在这里插入图片描述
六、编写测试UserController

package com.tc.controller;


import com.baomidou.mybatisplus.mapper.EntityWrapper;
import com.tc.entity.User;
import com.tc.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.web.bind.annotation.RestController;

import java.util.List;

/**
 * <p>
 *  前端控制器
 * </p>
 *
 * @author tc
 * @since 2020-06-11
 */
@RestController
@RequestMapping("/user")
public class UserController {
    @Autowired
    private UserService userService;
    @GetMapping("test")
	public List test(){
        List<User> users = userService.selectList(new EntityWrapper<>());
        return users;
    }
}

启动项目访问网页
在这里插入图片描述
七、添加Swagger2配置文件
在这里插入图片描述
代码

package com.tc.conf;


import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;
import java.util.List;

@Configuration
@EnableSwagger2
public class SwaggerConfiguration {
  @Bean
  public Docket createRestApi() {
    ParameterBuilder tokenPar = new ParameterBuilder();
    List<Parameter> pars = new ArrayList<Parameter>();
    tokenPar.name("ACCESS_TOKEN").description("令牌").modelRef(new ModelRef("string")).parameterType("header").required(false).build();
    pars.add(tokenPar.build());
    return new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(apiInfo())
            .select()
            .apis(RequestHandlerSelectors.basePackage("com.tc.controller"))
            .paths(PathSelectors.any())
            .build().globalOperationParameters(pars);
  }

  private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
            .title("title测试头")
            .description("测试描述")
            .version("1.0")
            .build();
  }
}

八、修改DemoApplication文件

@SpringBootApplication
@MapperScan("com.tc.dao")
public class DemoApplication {

    public static void main(String[] args) throws UnknownHostException {
        SpringApplication.run(DemoApplication.class, args);
        InetAddress ip4 = Inet4Address.getLocalHost();
        System.out.println("swagger:http://"+ip4.getHostAddress()+":8080/swagger-ui.html");
    }

}

九、修改userController

import org.springframework.web.bind.annotation.RestController;

import java.util.List;

/**
 * <p>
 *  前端控制器
 * </p>
 *
 * @author tc
 * @since 2020-06-11
 */
@RestController
@RequestMapping("/user")
public class UserController {
    @Autowired
    private UserService userService;
    @ApiOperation("测试")
    @GetMapping("test")
	public List test(){
        List<User> users = userService.selectList(new EntityWrapper<>());
        return users;
    }
}

github源码资源
https://github.com/tc-2019/demo
https://download.csdn.net/download/tan8924/12517706

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 2
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值