上篇简要介绍了spring boot,以及简单的项目搭建
本篇主要说明一些注解和相关的配置介绍
==================================================
入口类和@SpringBootApplication注解
上文说过,我们新建一个Project系统都会帮我们创建一个名为artifactId+Application的入口类,这个类中有一个main方法,这个main方法就是一个标准的Java应用程序的入口方法。而这里的@SpringBootApplication则是一个组合注解,我们可以看它的源码:
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(
excludeFilters = {@Filter(
type = FilterType.CUSTOM,
classes = {TypeExcludeFilter.class}
), @Filter(
type = FilterType.CUSTOM,
classes = {AutoConfigurationExcludeFilter.class}
)}
)
public @interface SpringBootApplication {
@AliasFor(
annotation = EnableAutoConfiguration.class,
attribute = "exclude"
)
Class<?>[] exclude() default {};
@AliasFor(
annotation = EnableAutoConfiguration.class,
attribute = "excludeName"
)
String[] excludeName() default {};
@AliasFor(
annotation = ComponentScan.class,
attribute = "basePackages"
)
String[] scanBasePackages() default {};
@AliasFor(
annotation = ComponentScan.class,
attribute = "basePackageClasses"
)
Class<?>[] scanBasePackageClasses() default {};
}
可以看到它组合了@SpringBootConfiguration、@EnableAutoConfiguration以及@ComponentScan,我们在开发的过程中如果不使用@SpringBootApplication,则可以组合使用这三个注解。这三个注解中,@SpringBootConfiguration就是@Configuration注解,是一个配置类,@EnableAutoConfiguration表示让Spring Boot根据类路径中的jar包依赖为当前项目进行自动配置,@ComponentScan的作用扫描实体类,唯一要注意的是如果我们使用了@SpringBootApplication注解的话,系统会去入口类的同级包以及下级包中去扫描实体类,因此我们建议入口类的位置在groupId+arctifactID组合的包名下。
关闭特定的自动配置
@ComponentScan注解有一个过滤器,如果只想要@SpringBootApplication去扫描特定的类而不是全部类,那么就可以关闭自动配置,如下:
@SpringBootApplication(exclude = DataSourceAutoConfiguration.class)
定制Banner
修改Banner
启动Spring Boot项目的时候,在控制台会默认输出一个启动图案,如下:
这个图案是可以自己修改的,修改方式:
1.在src/main/resources下新建一个banner.txt文档
2.通过http://patorjk.com/software/taag网站生成需要的字符,将字符拷贝到步骤1所创建的txt文档中,比如我这里为Hello iqux_anlve生成字符,如下:
控制台打印的效果
关闭Banner
可以修改当然也可以关闭,关闭Banner需要修改一下main方法中的代码,如下
public static void main(String[] args) {
SpringApplicationBuilder builder = new SpringApplicationBuilder(TestSpringbootApplication.class);
//修改Banner的模式为OFF
builder.annerMode(Banner.Mode.OFF).run(args);
}
修改之后再次启动Project的时候就看不到Banner了。
Spring Boot的配置文件
Spring Boot使用一个全局的配置文件application.properties或者application.yml,配置文件放在src/main/resources目录下。properties是我们常见的一种配置文件,Spring Boot不仅支持properties这种类型的配置文件,也支持yaml语言的配置文件,我这里以properties类型的配置文件为例来看几个案例。
1.修改Tomcat默认端口和默认访问路径
Tomcat默认端口是8080,我将之改为8081,默认访问路径是http://localhost:8080,我将之改为http://localhost:8081/helloboot,我们来看看这两个需求要怎么样通过简单的配置来实现。
很简单,在application.properties文件中添加如下代码:
server.context-path=/helloboot
server.port=8081
然后再启动Project,在浏览器中就得这样来访问了:
常规属性配置
使用Spring Boot在Spring容器框架下注入properties文件里的值,只需要在application.properties中定义属性,然后在代码中直接使用@Value注入即可。
如下:
book.author=罗贯中
book.name=三国演义
book.pinyin=sanguoyanyi
这里设置了中文,因为中文不做特殊处理会乱码,处理方式为继续在application.properties中添加如下代码:
server.tomcat.uri-encoding=UTF-8
spring.http.encoding.charset=UTF-8
spring.http.encoding.enabled=true
spring.http.encoding.force=true
spring.messages.encoding=UTF-8
然后 在IntelliJ IDEA中依次点击File -> Settings -> Editor -> File Encodings
将Properties Files (*.properties)下的Default encoding for properties files设置为UTF-8,将Transparent native-to-ascii conversion前的勾选上。
然后在变量中通过@Value直接注入就行了,如下:
@Value(value = "${book.author}")
private String bookAuthor;
@Value("${book.name}")
private String bookName;
@Value("${book.pinyin}")
private String bookPinYin;
修改index方法,使之返回这些值:
@RequestMapping(value = "/",produces = "text/plain;charset=UTF-8")
String index(){
return "Hello Spring Boot! The BookName is "+bookName+";and Book Author is "+bookAuthor+";and Book PinYin is "+bookPinYin;
}
然后在浏览器中访问,结果如下:
类型安全的配置
这种方式我们在实际项目中使用的时候工作量略大,因为每个项目要注入的变量的值太多了,这种时候我们可以使用基于类型安全的配置方式,就是将properties属性和一个Bean关联在一起,这样使用起来会更加方便。我么来看看这种方式怎么实现。
1.在src/main/resources文件夹下创建文件book.properties
文件内容如下:
book.name=红楼梦
book.author=曹雪芹
book.price=28
2.创建Book Bean,并注入properties文件中的值
代码如下:
@Component
@ConfigurationProperties(prefix = "book",locations = "classpath:book.properties")
public class BookBean {
private String name;
private String author;
private String price;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getAuthor() {
return author;
}
public void setAuthor(String author) {
this.author = author;
}
public String getPrice() {
return price;
}
public void setPrice(String price) {
this.price = price;
}
}
prefix是指前缀,location指定要注入文件的位置。
3.添加路径映射
在Controller中添加如下代码注入Bean:
@Autowired
private BookBean bookBean;
添加路径映射:
@RequestMapping("/book")
public String book() {
return "Hello Spring Boot! The BookName is "+bookBean.getName()+";and Book Author is "+bookBean.getAuthor()+";and Book price is "+bookBean.getPrice();
}
运行效果如下:
##注意:
##这里会有一些问题
日志配置
默认情况下Spring Boot使用Logback作为日志框架,可以手动配置日志级别以及日志输出位置,需要在application.properties中添加如下代码:
logging.file=/home/xxx/workspace/log.log
logging.level.org.springframework.web=debug
上面表示配置日志输出位置,下面配置日志级别。
Profile配置问题
在Spring Boot 中使用Profile更为简洁。全局Profile配置我们使用application-{profile}.properties来定义,然后在application.properties中通过spring.profiles.active来指定使用哪个Profile。
1.在src/main/resources文件夹下定义不同环境下的Profile配置文件,文件名分别为application-prod.properties和application-dev.properties,这两个前者表示生产环境下的配置,后者表示开发环境下的配置,如下: