【Spring|Spring Boot 2.0.0参考手册_中文版_Part III_14-18】文章作者:Tyan
博客:noahsnail.com|CSDN|简书
14. 组织你的代码 Spring Boot工作时不要求任何特定的代码布局,但是有一些最佳实践还是很有帮助的。
14.1 使用“default”包
当一个类没有包含一个package
声明时,它当做是在default package
中。通常情况下不建议使用default package
,应该避免使用它。当Spring Boot应用使用@ComponentScan
,@EntityScan
或@SpringBootApplication
它会引起一些特别的问题,因为Spring Boot会读取每个jar中的每个类。
我们建议你遵循Java推荐的包命名规范,使用一个反转的域名(例如,14.2 定义主应用类com.example.project
)。
通常我们建议你将你的主应用类放在其它类之上的根包中。
@EnableAutoConfiguration
注解经常放在你的主类(main class)中,对于某些像它隐式的定义了一个基search package
,例如,如果你正在写一个JPA应用,@EnableAutoConfiguration
注解的类所在的包将被用来搜索@Entity
项。根包的应用也允许使用
@ComponentScan
注解而不需要指定basePackage
特性。如果你的主类是在根包中,你也可以使用@SpringBootApplication
注解。下面是一个典型的布局:
com
+- example
+- myproject
+- Application.java
|
+- domain
|+- Customer.java
|+- CustomerRepository.java
|
+- service
|+- CustomerService.java
|
+- web
+- CustomerController.java
Application.java
文件会声明main
方法和基本的@Configuration
。package com.example.myproject;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
@Configuration
@EnableAutoConfiguration
@ComponentScan
public class Application {public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}}
15. 配置类 Spring Boot支持基于Java的注解。尽管可以通过XML源调用
SpringApplication.run()
方法,但我们通常建议你主要的源是一个@Configuration
类。网上已经发布了许多使用XML配置来进行Spring配置的例子。但要尽可能的尝试使用等价的Java注解。搜索15.1 导入额外的配置类enable*
注解是一个好的开端。
你不必将所有的
@Configuration
放到一个单独的类中。可以使用@Import
注解来导入额外的配置类。或者,你可以使用@ComponentScan
来自动获得所有的Spring组件,包括@Configuration
类。15.2 导入XML配置
如果你绝对的必须使用基于XML的配置,我们推荐你仍然从
@Configuration
类开始。你可以使用额外的@ImportResource
注解来加载XML配置文件。16. 自动配置 Spring Boot自动配置会基于你添加的jar依赖试图自动配置你的Spring应用。例如,如果
HSQLDB
在你的classpath中,并且你没有手动的配置任何数据库连接beans,我们将会在自动配置一个内存中的数据库。你需要通过添加
@EnableAutoConfiguration
或@SpringBootApplication
注解到你的@Configuration
类中的一个来选择性的加入自动配置。你应该仅添加一个16.1 逐渐替换自动配置@EnableAutoConfiguration
注解。我们通常建议你将它添加到你主要的@Configuration
类中。
自动配置是非入侵性的,在任何时候你都可以开始定义你自己的配置来替换自动配置的指定部分。例如,如果你要添加你自己的
DataSource
bean,默认嵌入的数据库支持将会退出。如果你需要找出当前正在应用的自动配置和为什么,你可以用
--debug
开关来启动你的应用。这将会使核心日志的输出级别变为debug级别并输出一个自动配置报告到控制台。16.2 禁用特定的自动配置
如果你发现正在应用特定的你不想使用的自动配置类,你可以使用
@EnableAutoConfiguration
注解的exclude
特性来禁用它们。import org.springframework.boot.autoconfigure.*;
import org.springframework.boot.autoconfigure.jdbc.*;
import org.springframework.context.annotation.*;
@Configuration
@EnableAutoConfiguration(exclude={DataSourceAutoConfiguration.class})
public class MyConfiguration {
}
如果这个类不在classpath中,你可以使用这个注解的
excludeName
特性并指定全限定名来代替。最后,你也可以通过spring.autoconfigure.exclude
属性来排除,从而控制自动配置类的列表。你也可以在注解级别或使用属性来定义排除项。17. Spring Beans和依赖注入 你可以自由的使用任何标准的Spring框架技术来定义你的beans和它们注入的依赖。为了简便,我们经常使用
@ComponentScan
来发现你的beans,结合@Autowired
构造函数注入也工作的很好。如果你根据上面的建议组织你代码(将你的应用类放在根包中),你可以添加
@ComponentScan
注解而不需要任何参数。你所有的应用组件(@Component
,@Service
,@Repository
,@Controller
等等)将会作为Spring bean进行自动注册。下面是一个
@Service
Bean的例子,通过使用构造函数注入来获得RiskAssessor
bean。package com.example.service;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
@Service
public class DatabaseAccountService implements AccountService {private final RiskAssessor riskAssessor;
@Autowired
public DatabaseAccountService(RiskAssessor riskAssessor) {
this.riskAssessor = riskAssessor;
}// ...}
注意使用构造函数注入允许18. 使用@SpringBootApplication注解 许多Spring Boot的开发者总是在它们的主类上加上riskAssessor
字段标记为final
,意味着它接下来不能被修改。
@Configuration
,@EnableAutoConfiguration
和@ComponentScan
注解。由于这些注解频繁的在一起使用(尤其是你遵循上面的最佳实践时),Spring Boot提供了一个方便的@SpringBootApplication
注解来代替它们。@SpringBootApplication
注解等价于使用@Configuration
,@EnableAutoConfiguration
和@ComponentScan
以及它们的默认特性:package com.example.myproject;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication // same as @Configuration @EnableAutoConfiguration @ComponentScan
public class Application {public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}}
@SpringBootApplication
也提供了别名来定制@EnableAutoConfiguration
和@ComponentScan
的特性。
推荐阅读
- =======j2ee|spring用注解实现注入的@resource,@autowired,@inject区别
- jar|springboot项目打成jar包和war包,并部署(快速打包部署)
- 数据库|效率最高的Excel数据导入---(c#调用SSIS Package将数据库数据导入到Excel文件中【附源代码下载】)...
- java人生|35K 入职华为Java开发那天,我哭了(这 5 个月做的一切都值了)
- Java毕业设计项目实战篇|Java项目:在线嘿嘿网盘系统设计和实现(java+Springboot+ssm+mysql+maven)
- 微服务|微服务系列:服务发现与注册-----Eureka(面试突击!你想了解的Eureka都在这里.持续更新中......)
- java|ApplicationListener和SpringApplicationRunListener的联系
- Spring|SpringSecurity--自定义登录页面、注销登录配置
- 性能|性能工具之 Jmeter 通过 SpringBoot 工程启动
- 代码狂魔|Spring源码分析之IOC容器初始化流程