title: springboot-1--基本结构
date: 2016-12-22 17:32:15
tags: springboot
categories: springboot
使用gradle新建一个springboot的工程。
gradle结构和意义解析
buildscript {
ext {
springBootVersion = '1.4.2.RELEASE'
}
repositories {
maven { url "http://repo.spring.io/snapshot" }
maven { url "http://repo.spring.io/milestone" }
mavenCentral()
}
dependencies {
classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}")//springboot gradle plugin需要的依赖
}
}
apply plugin: 'java'
apply plugin: 'spring-boot'//使用springboot gradle plugin
//apply plugin: 'war'
jar {
baseName = 'springBootDemo'
version = '0.0.1-SNAPSHOT'
}
sourceCompatibility = 1.8
targetCompatibility = 1.8
repositories {
mavenCentral()
}
configurations {
providedRuntime
all*.exclude module: 'spring-boot-starter-logging'//不想用默认的logback,排除掉，加入spring-boot-starter-log4j2，使用log4j2
}
dependencies {
compile 'com.google.guava:guava:19.0'//这个要多说？
compile('org.projectlombok:lombok:1.16.6')//去除javabean gettersetter的工具类)
compile('org.springframework.boot:spring-boot-starter-log4j2')//log4j2相关依赖
compile('org.springframework.boot:spring-boot-starter-web')//默认会引入嵌入的tomcat，想用jetty，可以排除掉tomcat，引入jetty依赖，做法类似于log
compile('org.springframework.boot:spring-boot-starter-actuator')//springboot提供的一个app状态监控服务
compile('org.springframework.boot:spring-boot-starter-aop')//aop功能
compile("org.springframework.boot:spring-boot-starter-data-rest")//rest
compile("org.mybatis.spring.boot:mybatis-spring-boot-starter:1.1.1")//mybatis和springboot配合的jar
testCompile('org.springframework.boot:spring-boot-starter-test')//看就知道是测试用的依赖了
compile 'com.alibaba:fastjson:1.2.14'//笔者喜欢用fastjson作为springmvc的序列化依赖，也可以使用默认的jackson
compile group: 'joda-time', name: 'joda-time', version: '2.9.4'//时间类型处理依赖，springmvc也需要
compile group: 'mysql', name: 'mysql-connector-java', version: '6.0.5'
//mybatis 分页插件依赖
compile 'com.github.pagehelper:pagehelper:4.1.3'
}
工程的大体结构:
可以看到比较奇特的地方是经典的webapp,WEB-INF,web.xml都没有了，取而代之的是resources文件夹下的static文件夹，代替放置静态文件。笔者将配置相关的java文件放在单独的包confiuration中。
基础注解
@SpringBootApplication
springboot的基础注解，其实是下面3个注解的简便集合：
@SpringBootConfiguration ：等同于@Configuration,而被@Configuration标记的类可以简单理解为xml配置中的一个spring配置文件。
@EnableAutoConfiguration : spring会根据你的jar依赖等尝试“智能“的去理解你需要哪些配置，其生效的顺序总是最后，默认的扫描包位置就是被注解的那个类的位置，所以官网建议将此被此annotation注解的类放在”root package“下，这样可以扫描到所有bean。
@ComponentScan ：扫描bean，可以指定位置，作用类似于xml中的component-scan
定制特殊配置
spring-boot会根据你导入的jar判断到底应该初始化哪些内容，比如springmvc，jdbctemplate之类的。除此以外我们往往需要一些自己的特殊化配置，比如tomcat的端口
jdbc的url，或者任何需要在程序中使用的属性。可以看到上面application结构图中有一个application.properties，如果不想折腾，全放在里面好了，然后在类中用@Value("${yourkey}")引用即可。但事实上spring为我们提供了多达将近20种方法去设置这些值。可以参考官网文档https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-external-config.html
集成mybatis
gradle中添加依赖，注意到集成jar是属于mybatis旗下的不？呵呵，mybatis每次都只能自己开发集成包，感觉好苦逼……
compile("org.mybatis.spring.boot:mybatis-spring-boot-starter:1.1.1")
compile group: 'mysql', name: 'mysql-connector-java', version: '6.0.5'
//mybatis 分页插件依赖
compile 'com.github.pagehelper:pagehelper:4.1.3'
接着在application.properties中添加数据源配置，springboot会自动扫描到，配置为datasource,笔者使用intellij，甚至会自动提示在application.properties中可以输入什么样的配置选项，再次感叹这款IDE的强大和贴心！
spring.datasource.url=jdbc:mysql://localhost:3307/test
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
配置mybatis相关的选项
@SpringBootApplication(scanBasePackages ="org.yyf.springBootDemo" )
@EnableTransactionManagement
@MapperScan("org.yyf.springBootDemo.dao")
public class DemoApplication {
public static void main(String[] args) {
SpringApplication.run(DemoApplication.class, args);
}
}
其中MapperScan将指定位置的mapper扫描为bean，按照官网的文档，只需在对应的Mapper接口文件上配置@Mapper注解就应该自动扫描到，但不知为何笔者的就是死活不行，所以额外配置了MapperScan
而@EnableTransactionManagement开启事物配置，作用类同于<tx:annotation-driven>
配置后可在对应的service bean上配置@Transcational开启事务管理。
另外，在application.properties中配置
mybatis.config-location=classpath:/mybatis-configuration.xml
mybatis.mapper-locations=classpath:/mapper/*.xml
其中前者为mybatis的细节配置，可以像这样单独放在一个文件中，也可以直接放在application.properties中，笔者还是习惯单独放。
后者是mappe的xml文件映射地址，笔者单独放在resources文件的mapper文件夹下。
其中mybatis-configuration.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>
<!-- Globally enables or disables any caches configured in any mapper under this configuration -->
<!--<setting name="cacheEnabled" value="true"/>-->
<!-- Sets the number of seconds the driver will wait for a response from the database -->
<!--<setting name="defaultStatementTimeout" value="3000"/>-->
<!-- Enables automatic mapping from classic database column names A_COLUMN to camel case classic Java property names aColumn -->
<setting name="mapUnderscoreToCamelCase" value="true"/>
<!-- Allows JDBC support for generated keys. A compatible driver is required.
This setting forces generated keys to be used if set to true,
as some drivers deny compatibility but still work -->
<!--<setting name="useGeneratedKeys" value="true"/>-->
<setting name="logImpl" value="LOG4J2"/>
</settings>
<typeHandlers>
<!--<typeHandler handler="org.apache.ibatis.type.EnumOrdinalTypeHandler" javaType=""/>-->
</typeHandlers>
<!-- Continue going here -->
<plugins>
<!-- com.github.pagehelper为PageHelper类所在包名 -->
<plugin interceptor="com.github.pagehelper.PageHelper">
<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="true"/>
<!-- 3.5.0版本可用 - 为了支持startPage(Object params)方法 -->
<!-- 增加了一个`params`参数来配置参数映射，用于从Map或ServletRequest中取值 -->
<!-- 可以配置pageNum,pageSize,count,pageSizeZero,reasonable,不配置映射的用默认值 -->
<property name="params" value="pageNum=start;pageSize=limit;pageSizeZero=zero;reasonable=heli;count=contsql"/>
</plugin>
</plugins>
<mappers>
</mappers>
</configuration>
springmvc使用fastjson序列化
本身springmvc使用的是Jackson，所以springboot默认不需要任何多余的配置，但是笔者偏爱fastjson，所以单独配置了web层使用fastjson。如下：
@EnableWebMvc
@Configuration
public class WebConfig extends WebMvcConfigurerAdapter{
@Bean
public TestInterceptor getTestInterceptor(){
return new TestInterceptor();
}
@Override
public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
FastJsonHttpMessageConverter fastConverter = new FastJsonHttpMessageConverter();//2
FastJsonConfig fastJsonConfig = new FastJsonConfig();
fastJsonConfig.setSerializerFeatures(
// SerializerFeature.PrettyFormat,
// SerializerFeature.WriteClassName,
SerializerFeature.WriteEnumUsingToString,
SerializerFeature.WriteNullListAsEmpty,
SerializerFeature.WriteNullStringAsEmpty
);
fastConverter.setFastJsonConfig(fastJsonConfig);
HttpMessageConverter<?> converter = fastConverter;
converters.add(converter);
}
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(getTestInterceptor());
}
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("/txt/**").addResourceLocations("classpath:/static/");
}
}
