spring-boot+jpa 确实十分强大 个人也很喜欢jpa中的方法名称推断
因为项目要用到spring-boot+mybaits 所以就有了这篇文章 简单的把例子在这里贴出来 方便以后查看
代码已经托管到了github
整合mybaits
在pom.xml中引入mybatis mysql dataSource依赖,添加如下内容:
<!-- 整合mybatis -->
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>${mybatis.version}</version>
</dependency>
<!-- mysql -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid</artifactId>
<version>1.0.14</version>
</dependency>
引入数据源配置文件 application-dev.yml
spring:
datasource:
url: jdbc:mysql://localhost:3306/test1?useUnicode=true&characterEncoding=utf-8
username: root
password: 123456
driver-class-name: com.mysql.jdbc.Driver
platform: mysql
#druid参考官方配置
initial-size: 1
max-active: 20
max-idle: 30
min-idle: 5
max-wait: 60000
#配置间隔多久才进行一次检测,检测需要关闭的空闲连接,单位是毫秒
time-between-eviction-runs-millis: 60000
#配置一个连接在池中最小生存的时间,单位是毫秒
min-evictable-idle-time-millis: 300000
validation-query: SELECT 'x'
test-while-idle: true
test-on-borrow: false
test-on-return: false
pool-prepared-statements: false
max-open-prepared-statements: 20
#配置监控统计拦截的filters
filters: stat
配置数据源
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;
@Configuration
@ConfigurationProperties(prefix="spring.datasource", ignoreNestedProperties = false)
public class DruidDataSourceConfig {
private String driverClassName;
private String url;
private String username;
private String password;
private int maxActive = 20;
private int maxIdle = 20;
private int minIdle = 1;
private int initialSize = 1;
private int maxWait = 60000;
private int timeBetweenEvictionRunsMillis = 60000;
private int minEictableIdleTimeMillis = 300000;
private boolean testOnBorrow = false;
private boolean testOnReturn = false;
private boolean testWhileIdle = true;
private String validationQuery;
private boolean poolPreparedStatements = false;
private int maxOpenPreparedStatements = 20;
private String filters = "stat";
public String getDriverClassName() {
return driverClassName;
}
public void setDriverClassName(String driverClassName) {
this.driverClassName = driverClassName;
}
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 int getMaxActive() {
return maxActive;
}
public void setMaxActive(int maxActive) {
this.maxActive = maxActive;
}
public int getMaxIdle() {
return maxIdle;
}
public void setMaxIdle(int maxIdle) {
this.maxIdle = maxIdle;
}
public int getMinIdle() {
return minIdle;
}
public void setMinIdle(int minIdle) {
this.minIdle = minIdle;
}
public int getInitialSize() {
return initialSize;
}
public void setInitialSize(int initialSize) {
this.initialSize = initialSize;
}
public int getMaxWait() {
return maxWait;
}
public void setMaxWait(int maxWait) {
this.maxWait = maxWait;
}
public int getTimeBetweenEvictionRunsMillis() {
return timeBetweenEvictionRunsMillis;
}
public void setTimeBetweenEvictionRunsMillis(int timeBetweenEvictionRunsMillis) {
this.timeBetweenEvictionRunsMillis = timeBetweenEvictionRunsMillis;
}
public int getMinEictableIdleTimeMillis() {
return minEictableIdleTimeMillis;
}
public void setMinEictableIdleTimeMillis(int minEictableIdleTimeMillis) {
this.minEictableIdleTimeMillis = minEictableIdleTimeMillis;
}
public boolean isTestOnBorrow() {
return testOnBorrow;
}
public void setTestOnBorrow(boolean testOnBorrow) {
this.testOnBorrow = testOnBorrow;
}
public boolean isTestOnReturn() {
return testOnReturn;
}
public void setTestOnReturn(boolean testOnReturn) {
this.testOnReturn = testOnReturn;
}
public boolean isTestWhileIdle() {
return testWhileIdle;
}
public void setTestWhileIdle(boolean testWhileIdle) {
this.testWhileIdle = testWhileIdle;
}
public String getValidationQuery() {
return validationQuery;
}
public void setValidationQuery(String validationQuery) {
this.validationQuery = validationQuery;
}
public boolean isPoolPreparedStatements() {
return poolPreparedStatements;
}
public void setPoolPreparedStatements(boolean poolPreparedStatements) {
this.poolPreparedStatements = poolPreparedStatements;
}
public int getMaxOpenPreparedStatements() {
return maxOpenPreparedStatements;
}
public void setMaxOpenPreparedStatements(int maxOpenPreparedStatements) {
this.maxOpenPreparedStatements = maxOpenPreparedStatements;
}
public String getFilters() {
return filters;
}
public void setFilters(String filters) {
this.filters = filters;
}
}
注入需要的bean
import java.io.IOException;
import java.sql.SQLException;
import javax.annotation.PostConstruct;
import javax.sql.DataSource;
import org.apache.ibatis.session.SqlSessionFactory;
import org.mybatis.spring.SqlSessionFactoryBean;
import org.mybatis.spring.annotation.MapperScan;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.StandardEnvironment;
import org.springframework.core.io.ClassPathResource;
import org.springframework.core.io.Resource;
import org.springframework.core.io.support.PathMatchingResourcePatternResolver;
import org.springframework.core.io.support.ResourcePatternResolver;
import org.springframework.jdbc.datasource.DataSourceTransactionManager;
import org.springframework.util.ClassUtils;
import com.alibaba.druid.pool.DruidDataSource;
@Configuration
@MapperScan(basePackages = "cn.sunxyz.mapper")
public class MybatisConfig {
private static final Logger logger = LoggerFactory.getLogger(MybatisConfig.class);
@Autowired
private DruidDataSourceConfig druidDataSourceConfig;
@Bean
public DataSource dataSource() {
logger.debug("druidDataSourceConfig" + druidDataSourceConfig);
// 加载配置文件属性
DruidDataSource ds = new DruidDataSource();
ds.setDriverClassName(druidDataSourceConfig.getDriverClassName());
ds.setUsername(druidDataSourceConfig.getUsername());
ds.setPassword(druidDataSourceConfig.getPassword());
ds.setUrl(druidDataSourceConfig.getUrl());
ds.setMaxActive(druidDataSourceConfig.getMaxActive());
ds.setValidationQuery(druidDataSourceConfig.getValidationQuery());
ds.setTestOnBorrow(druidDataSourceConfig.isTestOnBorrow());
ds.setTestOnReturn(druidDataSourceConfig.isTestOnReturn());
ds.setTestWhileIdle(druidDataSourceConfig.isTestWhileIdle());
ds.setTimeBetweenEvictionRunsMillis(druidDataSourceConfig.getTimeBetweenEvictionRunsMillis());
ds.setMinEvictableIdleTimeMillis(druidDataSourceConfig.getMinEictableIdleTimeMillis());
ds.setPoolPreparedStatements(druidDataSourceConfig.isPoolPreparedStatements());
ds.setMaxOpenPreparedStatements(druidDataSourceConfig.getMaxOpenPreparedStatements());
try {
ds.setFilters(druidDataSourceConfig.getFilters());
} catch (SQLException e) {
e.printStackTrace();
}
return ds;
}
@Bean
public SqlSessionFactory sqlSessionFactory() throws Exception {
logger.debug("--> sqlSessionFactory");
final SqlSessionFactoryBean sqlSessionFactory = new SqlSessionFactoryBean();
sqlSessionFactory.setDataSource(dataSource());
sqlSessionFactory.setConfigLocation(new ClassPathResource("mybatis-config.xml"));
sqlSessionFactory.setFailFast(true);
sqlSessionFactory.setMapperLocations(getResource("mapper", "**/*.xml"));
return sqlSessionFactory.getObject();
}
@Bean
public DataSourceTransactionManager transactionManager() {
logger.debug("> transactionManager");
return new DataSourceTransactionManager(dataSource());
}
@PostConstruct
public void postConstruct() {
logger.info("jdbc.settings={}", druidDataSourceConfig);
}
public Resource[] getResource(String basePackage, String pattern) throws IOException {
String packageSearchPath = ResourcePatternResolver.CLASSPATH_ALL_URL_PREFIX + ClassUtils.convertClassNameToResourcePath(new StandardEnvironment().resolveRequiredPlaceholders(basePackage)) + "/" + pattern;
Resource[] resources = new PathMatchingResourcePatternResolver().getResources(packageSearchPath);
return resources;
}
}
完成以上步骤 mybatis+spring-boot整合就完成了
整合pagehelper
在pom.xml中引入pagehelper依赖:
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper</artifactId>
<version>4.1.6</version>
</dependency>
添加 mybatis-config.xml配置文件
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN" "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
<settings>
<setting name="cacheEnabled" value="true" />
<!-- <setting name="lazyLoadingEnabled" value="true" /> <setting name="aggressiveLazyLoading"
value="true" /> <setting name="useGeneratedKeys" value="true" /> <setting
name="defaultExecutorType" value="SIMPLE" /> <setting name="defaultStatementTimeout"
value="10" /> -->
</settings>
<plugins>
<!-- com.github.pagehelper为PageHelper类所在包名 -->
<plugin interceptor="com.github.pagehelper.PageHelper">
<!-- 4.0.0以后版本可以不设置该参数 -->
<property name="dialect" value="mysql" />
<!-- 该参数默认为false -->
<!-- 设置为true时,会将RowBounds第一个参数offset当成pageNum页码使用 -->
<!-- 和startPage中的pageNum效果一样 -->
<property name="offsetAsPageNum" value="true" />
<!-- 该参数默认为false -->
<!-- 设置为true时,使用RowBounds分页会进行count查询 -->
<property name="rowBoundsWithCount" value="true" />
<!-- 设置为true时,如果pageSize=0或者RowBounds.limit = 0就会查询出全部的结果 -->
<!-- (相当于没有执行分页查询,但是返回结果仍然是Page类型) -->
<property name="pageSizeZero" value="true" />
<!-- 3.3.0版本可用 - 分页参数合理化,默认false禁用 -->
<!-- 启用合理化时,如果pageNum<1会查询第一页,如果pageNum>pages会查询最后一页 -->
<!-- 禁用合理化时,如果pageNum<1或pageNum>pages会返回空数据 -->
<property name="reasonable" value="false" />
<!-- 3.5.0版本可用 - 为了支持startPage(Object params)方法 -->
<!-- 增加了一个`params`参数来配置参数映射,用于从Map或ServletRequest中取值 -->
<!-- 可以配置pageNum,pageSize,count,pageSizeZero,reasonable,orderBy,不配置映射的用默认值 -->
<!-- 不理解该含义的前提下,不要随便复制该配置 -->
<!-- <property name="params"
value="pageNum=pageHelperStart;pageSize=pageHelperRows;" /> -->
<!-- 支持通过Mapper接口参数来传递分页参数 -->
<property name="supportMethodsArguments" value="false" />
<!-- always总是返回PageInfo类型,check检查返回类型是否为PageInfo,none返回Page -->
<property name="returnPageInfo" value="none" />
</plugin>
</plugins>
</configuration>
使用 : 一个简单的示例
public List<User> findAll(){
PageHelper.startPage(1, 2);
return userMapper.fingAll();
}
更多细节 可以访问 作者项目主页
Swagger2
在pom.xml中加入Swagger2的依赖:
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.2.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.2.2</version>
</dependency>
创建Swagger2配置类
@Configuration
@EnableSwagger2
public class Swagger2 {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("cn.sunxyz.web"))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("Spring Boot中使用Swagger2构建RESTful APIs")
.description("API文档")
.contact("summer_last")
.version("1.0")
.build();
}
}
添加描述 可以使用下面两个注解添加详细描述
@ApiOperation
@ApiImplicitParam
完成上述代码添加上,启动Spring Boot程序,访问:http://localhost:8080/swagger-ui.html 即可看到RESTful API的页面
更多细节可以 查看 Swagger官方网站