SpringBoot+Mybatis+Druid+Swagger集成简单demo

最近刚学SpringBoot不久，结合网上做了一个SpringBoot集成Mybatis+Druid+Swagger的简单demo，记录在博客之中，分享给大家，同时也给自己学习记录用。废话不多说，直接开始。（本实例使用的开发工具为Intellij IDEA 2017.1.4）

步骤:

1.用IDEA新建一个WEB项目:

项目名这些我就不改了，一切按照默认。

这里只勾选一个WEB，实际上可以在SQL里面再勾选Mybatis和Mysql，不过我打算后续在pom.xml中直接引入依赖。最后next后选择路径finish即可。

2.文件结构

这是刚创建后的文件结构

这是最终的文件结构，大家可以照着我这个创，也可以按自己习惯自行创建。

3.在pom.xml中引入依赖

pom.xml里面初始的依赖应该只有下面这样

<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-web</artifactId>
</dependency>

<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-test</artifactId>
	<scope>test</scope>
</dependency>

然后我们引入mybatis，mysql，druid，以及swagger的依赖

mysql和mybatis

<dependency>
	<groupId>org.mybatis.spring.boot</groupId>
	<artifactId>mybatis-spring-boot-starter</artifactId>
	<version>1.3.2</version>
</dependency>

<dependency>
	<groupId>mysql</groupId>
	<artifactId>mysql-connector-java</artifactId>
	<version>5.1.37</version>
	<scope>runtime</scope>
</dependency>

druid和Swagger

<!--druid连接池-->
<dependency>
	<groupId>com.alibaba</groupId>
	<artifactId>druid</artifactId>
	<version>1.1.10</version>
   </dependency>
<!--配置文件属性值自动注入-->
<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-configuration-processor</artifactId>
	<optional>true</optional>
</dependency>

<!-- Swagger API文档 -->
<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>

在引入依赖的时候IDEA应该会在右下角有这样的提示

点击Eanble Auto-Import，这样你输完语句保存之后就会自动引入依赖了。

这边mysql的依赖有一点要注意下，如果是在创建项目的时候勾选了Mysql，这里会自动引入依赖，但是默认是没有版本号的，原因如下：

<parent>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-parent</artifactId>
	<version>2.1.2.RELEASE</version>
	<relativePath/> <!-- lookup parent from repository -->
</parent>

在pom.xml最上面可以看到这个用parent标签包裹的内容，而spring-boot-starter-parent会自动为开发者提供常用的jar包的版本管理，而RELEASE代表的就是使用最新且稳定的jar包，然而我这边用的还是Mysql5。在Mysql5和Mysql5以上的版本，Spring的datasource里面连接type和url是稍微有些不一样的，这也是我做这个demo遇到的最大的坑。这边给大家一个提醒。

4.建立数据库并添加数据

实际上也就一张很简单的表，给大家看一下结构和数据就好了，应该不至于有不会建表的吧，大家自己看着建。

6.配置application.properties

虽说SpringBoot是简化了很多配置文件，但是该配置的还是要配置的，配置文件如下，数据库连接信息这些自己看着改，mybatis的设置是跟之前的文件结构有关，如果跟我一样的文件结构的话，应该是不用改的了。

spring.datasource.url=jdbc:mysql://localhost:3306/db_demo？useUnicode=true&characterEncoding=utf8
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.type=com.alibaba.druid.pool.DruidDataSource

#连接池的配置信息
spring.datasource.initialSize=5
spring.datasource.minIdle=5
spring.datasource.maxActive=20
spring.datasource.maxWait=60000
spring.datasource.timeBetweenEvictionRunsMillis=60000
spring.datasource.minEvictableIdleTimeMillis=300000
spring.datasource.validationQuery=SELECT 1
spring.datasource.testWhileIdle=true
spring.datasource.testOnBorrow=false
spring.datasource.testOnReturn=false
spring.datasource.poolPreparedStatements=true
spring.datasource.maxPoolPreparedStatementPerConnectionSize=20
spring.datasource.filters=stat,wall
spring.datasource.connectionProperties=druid.stat.mergeSql=true;druid.stat.slowSqlMillis=5000

mybatis.typeAliasesPackage=com.example.demo.model
mybatis.mapperLocations=classpath:mapper/*.xml
server.port=8080

7.建立文件

在model文件夹下建立User类，包名之类的我就不添加上去了。

public class User {
    private int id;
    private String username;
    private String password;

    public int getId() {
        return id;
    }

    public String getUsername() {
        return username;
    }

    public String getPassword() {
        return password;
    }

    public void setId(int id) {
        this.id = id;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public void setPassword(String password) {
        this.password = password;
    }

    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", username='" + username + '\'' +
                ", password='" + password + '\'' +
                '}';
    }
}

在dao文件夹下创建UserDao接口

@Mapper
public interface UserDao {
    List<User> selectUsers();
}

在resource/mapper下建立UserMapper.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd" >
<mapper namespace="com.example.demo.dao.UserDao">
    <select id="selectUsers" resultType="com.example.demo.model.User">
        select * from t_user
    </select>
</mapper>

在Service文件夹下创建UserService

@Service
public class UserService {
    @Autowired
    UserDao userDao;
    public List<User> selectUsers(){
        List<User> list = userDao.selectUsers();
        return list;
    }
}

在Controller文件夹下创建UserController

@RestController
@RequestMapping(value = "/test")
@EnableAutoConfiguration
public class UserController {

    @Autowired
    private UserService userService;

    @RequestMapping(value = "/user")
    public List<User> getUser(){
        return userService.selectUsers();
    }
}

以上都是一些很简单的例子，学过SSM的应该都了解。注意一些注解别漏了

在DemoApplication中加上注解@MapperScan("com.example.demo.dao")

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

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

}

配置完成后，应该是已经能访问到Controller里的action了，下面来测试一下。点击Tools-Test RESTful Web Service

在Host/port和Path处填入地址和action，最后点击左边的运行，如果Response有获取到以上数据，就说明mybatis已经正常使用了。接下来做druid监控的配置

8.配置druid监控服务

配置druid文件的监控服务，需要配置servlet和filter，SpringBoot中一般有两种方式可以配置servlet和filter，bean方式和注解方式，这边用的是bean方式。在config文件夹下建立DruidConfig，代码如下

@Configuration
public class DruidConfig {
    @Bean
    public ServletRegistrationBean druidServlet() {
        ServletRegistrationBean reg = new ServletRegistrationBean();
        reg.setServlet(new StatViewServlet());
        reg.addUrlMappings("/druid/*");
        reg.addInitParameter("loginUsername", "root");
        reg.addInitParameter("loginPassword", "123456");
        reg.addInitParameter("logSlowSql", "true");
        return reg;
    }

    @Bean
    public FilterRegistrationBean filterRegistrationBean() {
        FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean();
        filterRegistrationBean.setFilter(new WebStatFilter());
        filterRegistrationBean.addUrlPatterns("/*");
        //过滤文件类型
        filterRegistrationBean.addInitParameter("exclusions", "*.js,*.gif,*.html,*.jpg,*.png,*.css,*.ico,/druid/*");
        filterRegistrationBean.addInitParameter("profileEnable", "true");
        return filterRegistrationBean;
    }
}

配置完成后，运行项目，在地址栏输入http://localhost:8080/druid就可以访问到druid了，如图所示，输入配置文件中所填的username和password就可以登录了

进入之后如图所示，不过目前点击数据源和SQL监控是没东西的，因为目前还没有配置数据源，所以接下来要配置数据源

在config和bean文件夹下分别建立MybatisConfig和DruidBean，代码如下

MybatisConfig.java

@Configuration
public class MybatisConfig {

    @Autowired
    DruidBean druidProperties;//这里会有一个Could not autowire. No beans of 'xxxx' type found的提示，不影响运行

    private DruidDataSource dataSourceStrom() {
        DruidDataSource dataSource = new DruidDataSource();
        druidProperties.config(dataSource);
        return dataSource;
    }

    @Bean(initMethod = "init",destroyMethod = "close")
    public DruidDataSource dataSource() {
        return dataSourceStrom();
    }


}

DruidBean.java

@Component
//可以将application.properties中前缀为spring.datasource的配置项，自动注入到当前bean中
@ConfigurationProperties(prefix = "spring.datasource")
public class DruidBean {

    private String url;

    private String username;

    private String password;

    private String driverClassName ;

    private Integer initialSize = 2;

    private Integer minIdle = 1;

    private Integer maxActive = 20;

    private Integer maxWait = 60000;

    private Integer timeBetweenEvictionRunsMillis = 60000;

    private Integer minEvictableIdleTimeMillis = 300000;

    private String validationQuery = "SELECT 'x'";

    private Boolean testWhileIdle = true;

    private Boolean testOnBorrow = false;

    private Boolean testOnReturn = false;

    private Boolean poolPreparedStatements = true;

    private Integer maxPoolPreparedStatementPerConnectionSize = 20;

    private String filters = "stat";

    public void config(DruidDataSource dataSource) {

        dataSource.setUrl(url);
        dataSource.setUsername(username);
        dataSource.setPassword(password);

        dataSource.setDriverClassName(driverClassName);
        dataSource.setInitialSize(initialSize);     //定义初始连接数
        dataSource.setMinIdle(minIdle);             //最小空闲
        dataSource.setMaxActive(maxActive);         //定义最大连接数
        dataSource.setMaxWait(maxWait);             //最长等待时间

        // 配置间隔多久才进行一次检测，检测需要关闭的空闲连接，单位是毫秒
        dataSource.setTimeBetweenEvictionRunsMillis(timeBetweenEvictionRunsMillis);

        // 配置一个连接在池中最小生存的时间，单位是毫秒
        dataSource.setMinEvictableIdleTimeMillis(minEvictableIdleTimeMillis);
        dataSource.setValidationQuery(validationQuery);
        dataSource.setTestWhileIdle(testWhileIdle);
        dataSource.setTestOnBorrow(testOnBorrow);
        dataSource.setTestOnReturn(testOnReturn);

        dataSource.setPoolPreparedStatements(poolPreparedStatements);
        dataSource.setMaxPoolPreparedStatementPerConnectionSize(maxPoolPreparedStatementPerConnectionSize);

        try {
            dataSource.setFilters(filters);
        } catch (SQLException e) {
            e.printStackTrace();
        }
    }


    public String getUrl() {
        return url;
    }

    public void setUrl(String url) {
        this.url = url;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }

    public String getDriverClassName() {
        return driverClassName;
    }

    public void setDriverClassName(String driverClassName) {
        this.driverClassName = driverClassName;
    }

    public Integer getInitialSize() {
        return initialSize;
    }

    public void setInitialSize(Integer initialSize) {
        this.initialSize = initialSize;
    }

    public Integer getMinIdle() {
        return minIdle;
    }

    public void setMinIdle(Integer minIdle) {
        this.minIdle = minIdle;
    }

    public Integer getMaxActive() {
        return maxActive;
    }

    public void setMaxActive(Integer maxActive) {
        this.maxActive = maxActive;
    }

    public Integer getMaxWait() {
        return maxWait;
    }

    public void setMaxWait(Integer maxWait) {
        this.maxWait = maxWait;
    }

    public Integer getTimeBetweenEvictionRunsMillis() {
        return timeBetweenEvictionRunsMillis;
    }

    public void setTimeBetweenEvictionRunsMillis(Integer timeBetweenEvictionRunsMillis) {
        this.timeBetweenEvictionRunsMillis = timeBetweenEvictionRunsMillis;
    }

    public Integer getMinEvictableIdleTimeMillis() {
        return minEvictableIdleTimeMillis;
    }

    public void setMinEvictableIdleTimeMillis(Integer minEvictableIdleTimeMillis) {
        this.minEvictableIdleTimeMillis = minEvictableIdleTimeMillis;
    }

    public String getValidationQuery() {
        return validationQuery;
    }

    public void setValidationQuery(String validationQuery) {
        this.validationQuery = validationQuery;
    }

    public Boolean getTestWhileIdle() {
        return testWhileIdle;
    }

    public void setTestWhileIdle(Boolean testWhileIdle) {
        this.testWhileIdle = testWhileIdle;
    }

    public Boolean getTestOnBorrow() {
        return testOnBorrow;
    }

    public void setTestOnBorrow(Boolean testOnBorrow) {
        this.testOnBorrow = testOnBorrow;
    }

    public Boolean getTestOnReturn() {
        return testOnReturn;
    }

    public void setTestOnReturn(Boolean testOnReturn) {
        this.testOnReturn = testOnReturn;
    }

    public Boolean getPoolPreparedStatements() {
        return poolPreparedStatements;
    }

    public void setPoolPreparedStatements(Boolean poolPreparedStatements) {
        this.poolPreparedStatements = poolPreparedStatements;
    }

    public Integer getMaxPoolPreparedStatementPerConnectionSize() {
        return maxPoolPreparedStatementPerConnectionSize;
    }

    public void setMaxPoolPreparedStatementPerConnectionSize(Integer maxPoolPreparedStatementPerConnectionSize) {
        this.maxPoolPreparedStatementPerConnectionSize = maxPoolPreparedStatementPerConnectionSize;
    }

    public String getFilters() {
        return filters;
    }

    public void setFilters(String filters) {
        this.filters = filters;
    }
}

接下来重启项目，重复继续访问http://localhost:8080/druid，登录之后点击数据源，就可以看到数据源啦。如图所示

但是，此时SQL监控还是没有东西的，这时候你访问一下http://localhost:8080/test/user，就会执行到select * from t_user，然后在SQL监控中就会出现这一句SQL的监控了（我这边访问了两次）

接下来就只剩下最后一步

9.配置Swagger以及使用Swagger UI

在config目录下新建SwaggerConfig，代码如下

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket swaggerPlugin() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.demo"))
                .paths(PathSelectors.any()).build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("SpringBoot+Mybatis+druid+swagger2")
                .licenseUrl("123")
                .description("描述")
                .version("1.0")
                .build();
    }
}

然后在controller文件下加入注解，同时在/user的action那边加上method=RequestMethod.POST(这边只是指定该方法的http请求为post，不指定的话，在SwaggerUI的控制台上会显示该方法的所有HTTP请求)

@RestController
@RequestMapping(value = "/test")
@EnableAutoConfiguration
@Api(value = "用户Controller", description = "用户Controller")
public class UserController {

    @Autowired
    private UserService userService;

    @RequestMapping(value = "/user",method = RequestMethod.POST)
    @ApiOperation(value = "获取所有用户", notes = "获取所有用户")
    public List<User> getUser(){
        return userService.selectUsers();
    }
}

然后，重启项目，在浏览器输入http://localhost:8080/swagger-ui.html就能访问到swagger的API控制台啦，如图所示：

点开用户Controller,里面就可以看到我们写的getUser方法以及描述(就是写在@ApiOperation里面的内容)，然后点击Try it out，就可以测试到我们写的这个方法了

ok，一个SpringBoot+Mybatis+druid+swagger的简单demo就完成了。这是最后整个项目的文件结构图