在项目开发流程中需要使用SpringBoot+Mybatis+Druid+Swagger,所以简单制作了一个demo记录学习过程。
配置项目环境
导入依赖选择Web->Spring Web,Sql->Mybatis Framework,MySql Server。创建成功后在项目中建立如图文件夹:
在pom.xml中注入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>
创建demo数据库
配置application.properties
spring.datasource.url=jdbc:mysql://localhost:3306/db
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.driver-class-name=com.mysql.cj.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.type-aliases-package=com.dtjoy.model
mybatis.mapper-locations=classpath:mapper/*.xml
server.port=8080
建立与数据库中实体对应的实体类
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用于映射Dao层对应方法的Sql语句
<?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.dtjoy.dao.UserDao">
<select id="selectUsers" resultType="com.dtjoy.model.User">
select * from t_user
</select>
</mapper>
构建Service层以及对象
@Service
public class UserService {
@Autowired
UserDao userDao;
public List<User> selectUsers(){
List<User> list = userDao.selectUsers();
return list;
}
}
构建Controller层及对象
@RestController
@RequestMapping(value = "/test")
@EnableAutoConfiguration
public class UserController {
@Autowired
private UserService userService;
@RequestMapping(value = "/user")
public List<User> getUser(){
return userService.selectUsers();
}
}
以上的对象在建立过程中不能漏掉注解,否则会导致Spring对象注入失败。
最后在主程序中加上@MapperScan注解表示扫描项目中的哪些包
@SpringBootApplication
@MapperScan("com.dtjoy.dao")
public class DemoApplication {
public static void main(String[] args) {
SpringApplication.run(DemoApplication.class, args);
}
}
然后可以进入浏览器或者spring里的Rest client测试url:http://localhost:8080/test/user
以上说明对Mybatis的集成已经成功了,项目能够成功从数据库中操作数据。
配置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了,但是目前点击数据源和SQL监控是没有东西显示,因为目前还没有配置数据源,配置数据源在config和bean文件夹下分别建立MybatisConfig和DruidBean。
@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();
}
}
@Component
@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 (Exception 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;
}
}
重启项目,可以正常访问,也能看到数据源,sql监视,url监视。
配置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.dtjoy"))
.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 = "UserController", description = "用户的Controller")
public class UserController {
@Autowired
private UserService userService;
@RequestMapping(value = "/user",method = RequestMethod.POST)
@ApiOperation(value = "get_All_Users",notes="获取所有用户")
public List<User> getUser(){
return userService.selectUsers();
}
}
重启项目,在浏览器输入http://localhost:8080/swagger-ui.html就能访问到swagger的API控制台
参考文章:SpringBoot+Mybatis+Druid+Swagger集成简单demo