Spring注解
- @Repository、@Component、@Service、@Constroller,都是将一个类标识为Bean,Spring容器根据注解的过滤规则扫描读取注解Bean定义类,并将其注册到Spring IoC容器中,它们分别用于软件系统的不同层次:
- @Repository 将 DAO 类声明为 Bean,同时它还能将所标注的类中抛出的数据访问异常封装为 Spring 的数据访问异常类型。
- @Component 是一个泛化的概念,仅仅表示一个组件 (Bean) ,可以作用在任何层次。
- @Service通常作用在业务层,但是目前该功能与 @Component 相同。
-
@Constroller 通常作用在控制层,但是目前该功能与 @Component 相同。
-@Autowired进行装配,默认是byType的方式进行自动装配的。- @Autowired 注解可以用于 Setter 方法、构造函数、字段, 甚至普通方法,前提是方法必须有至少一个参数。
- @Autowired 可以用于数组和使用泛型的集合类型。然后 Spring 会将容器中所有类型符合的 Bean 注入进来。
- @Autowired 标注作用于 Map 类型时,如果 Map 的 key 为 String 类型,则 Spring 会将容器中所有类型符合 Map 的 value 对应的类型的 Bean 增加进来,用 Bean 的 id 或 name 作为 Map 的 key。
- 当标注了 @Autowired 后,自动注入不能满足,则会抛出异常。
- @Resource 默认是byName的方式进行自动装配的,只有当找不到匹配的名称或者Id时才按类型进行装配。如:
@Resource(name=”userDao”)
private UsreDao userDao;
-
@Value可以在类里调用设置在application.properties里的变量。访问方法是:
@Value("${xxx}")
-
@Bean 放在方法上,意思就是让这个方法产生一个Bean,并且交给Spring容器管理。所以这个方法最后一定会返回一个对象。并且我们还可以在@Bean上设置一个name值,
@Bean(name = "dataSource")
这样就可以在自动装配时,通过指定name来指定装配对象。如果未通过@Bean指定bean的名称,则默认与标注的方法名相同。 - @Scope @Bean注解默认作用域为单例singleton作用域,可通过@Scope(“prototype”)设置为原型作用域;每次通过容器的getBean方法获取prototype定义的Bean时,都将产生一个新的Bean实例。
-
@Qualifier 手动指定byName的方式注入,一般和@Autowired配合使用,因为这个默认是byType的方式,如:
@Qualifier("dataSource")
- @Configuration 官方说法:从Spring3.0,@Configuration用于定义配置类,可替换xml配置文件,被注解的类内部包含有一个或多个被@Bean注解的方法,这些方法将会被AnnotationConfigApplicationContext或AnnotationConfigWebApplicationContext类进行扫描,并用于构建bean定义,初始化Spring容器。
- 实际可理解为用spring的时候xml里面的<beans>标签,@Bean可理解为用spring的时候xml里面的<bean>标签。注意:spring Boot不是spring的加强版,所以@Configuration和@Bean同样可以用在普通的spring项目中,而不是Spring Boot特有的,只是在spring用的时候,注意加上扫包配置<context:component-scan base-package="com.xxx.xxx" />或者@ComponentScan注解(@ComponentScan等价于<context:component-scan base-package="com.xxx"/>)。
@Configuration
public class ExampleConfiguration {
@Value("com.mysql.jdbc.Driver")
private String driverClassName;
@Value("jdbc://xxxx.xx.xxx/xx")
private String driverUrl;
@Value("${root}")
private String driverUsername;
@Value("123456")
private String driverPassword;
@Bean(name = "dataSource")
public DataSource dataSource() {
BasicDataSource dataSource = new BasicDataSource();
dataSource.setDriverClassName(driverClassName);
dataSource.setUrl(driverUrl);
dataSource.setUsername(driverUsername);
dataSource.setPassword(driverPassword);
return dataSource;
}
@Bean
public PlatformTransactionManager transactionManager() {
return new DataSourceTransactionManager(dataSource());
}
}
// 使用:
@Autowired
private DataSource dataSource;
// 此外,@Configuration 也可以去注册@Component的Bean,不过要用@ComponentScan()同时标注好要扫描的包,而包下面有@Componen注解的类才行。
// 再此外,@Configuration还可以和@ImportResource("classpath:applicationContext-configuration.xml")组合载入xml文件配置
- @ConfigurationProperties 根据前缀分类映射到不同对象.
// 假设.properties文件如下:
test.name=cy
test.port=8090
test.servers[0]=dev.bar.com
test.servers[1]=foo.bar.com
// 对应调用类如下:
@ConfigurationProperties(prefix="test")
public class Config {
private String name;
private Integer port;
private List<String> servers = new ArrayList<String>();
public String geName(){
return this.name;
}
public Integer gePort(){
return this.port;
}
public List<String> getServers() {
return this.servers;
}
}
- Spring Boot 会自动将prefix=”test”前缀为my的属性注入进来。
- Spring Boot 会自动转换类型,当使用List的时候需要注意在配置中对List进行初始化!
- 注意,新版的已经将location属性移除。如果实现想指定资源路径,可如下替代:
@Component
@ConfigurationProperties(prefix = "test")
@PropertySource("classpath:test.properties")
补充:属性间可以用${}来引用前面的变量。
补充2:属性匹配规则:如果变量是firstName,则属性名可以是
1:person.firstName,标准的驼峰式命名,
2:person.first-name,虚线(-)分割方式,推荐在.properties和.yml配置文件中使用,
3:PERSON_FIRST_NAME,大写下划线形式,建议在系统环境变量中使用
-
@ResponseBody 表示该方法的返回结果直接写入 HTTP response body 中,通常用来返回JSON数据或者是XML。
-
@RequestBody 是作用在形参列表上,用于将前台发送过来固定格式的数据【xml 格式或者 json等】封装为对应的 JavaBean 对象,封装时使用到的一个对象是系统默认配置的 HttpMessageConverter进行解析,然后封装到形参上。
-
例如:(不用@RequestBody时的情况)
@RequestMapping("/login.do")
@ResponseBody
public Object login(String name, String password, HttpSession session) {
user = userService.checkLogin(name, password);
session.setAttribute("user", user);
return new JsonResult(user);
}
- 使用@RequestBody时的情况:
@RequestMapping("/login.do")
@ResponseBody
public Object login(@RequestBody User loginUuser, HttpSession session) {
user = userService.checkLogin(loginUser);
session.setAttribute("user", user);
return new JsonResult(user);
}
- PathVariable 处理requet uri部分,当使用@RequestMapping URI template 样式映射时,即someUrl/{paramId},这时的paramId可通过@Pathvariable 注解绑定它传过来的值到方法的参数上
@Controller
@RequestMapping("/owners/{a}")
public class RelativePathUriTemplateController {
@RequestMapping("/pets/{b}")
public void findPet(@PathVariable("a") String a,@PathVariable String b, Model model) {
// implementation omitted
}
}
- @RequestHeader 处理request header部分的注解
@RequestMapping("/test")
public void displayHeaderInfo(@RequestHeader("Accept-Encoding") String encoding,
@RequestHeader("Keep-Alive")long keepAlive) {
//...
}
- @CookieValue 将cookie里JSESSIONID绑定到方法参数上
@RequestMapping("/test")
public void displayHeaderInfo(@CookieValue("JSESSIONID") String cookie) {
//...
}
- @ResponseStatus 用于修饰一个类或者一个方法,修饰一个类的时候,一般修饰的是一个异常类,当处理器的方法被调用时,@ResponseStatus指定的code和reason会被返回给前端。value属性是http状态码,比如404,500等。reason是错误信息
- 当修改类或方法时,只要该类得到调用,那么value和reason都会被添加到response里
@ResponseStatus(value=HttpStatus.FORBIDDEN, reason="出现了错误")
public class UserException extends RuntimeException{
XXXXX
}
//当某处抛出UserException时,则会把value和reason返回给前端。
@RequestMapping("/testResponseStatus")
public String testResponseStatus(int i){
if(i==0)
throw new UserNotMatchException();
return "hello";
}
- @ControllerAdvice 把@ControllerAdvice注解内部使用@ExceptionHandler、@InitBinder、@ModelAttribute注解的方法应用到所有的 @RequestMapping注解的方法。不过一般只有当使用@ExceptionHandler最有用,另外两个用处不大。
@ControllerAdvice
public class GlobalExceptionHandler {
@ExceptionHandler(SQLException.class) // 表示让Spring捕获到所有抛出的SQLException异常,并交由这个被注解的handleSQLException方法处理,
@ResponseStatus(value=HttpStatus.INTERNAL_SERVER_ERROR,reason=”sql查询错误”) // @ResponseStatus指定了code和reason写到response上,返回给前端。
@ResponseBody
public ExceptionResponse handleSQLException(HttpServletRequest request, Exception ex) {
String message = ex.getMessage();
return ExceptionResponse.create(HttpStatus.INTERNAL_SERVER_ERROR.value(), message);
}
}
即表示让Spring捕获到所有抛出的SQLException异常,并交由这个被注解的handleSQLException方法处理,同时使用@ResponseStatus指定了code和reason写到response上,返回给前端。
- <mvc:annotation-driven/>相当于注册了DefaultAnnotationHandlerMapping和AnnotationMethodHandlerAdapter两个bean;
SpringBoot注解
- @RestController 在源码声明上同时有 @Controller 和 @ResponseBody 注解,所以使用了这个注解的类会被看作一个Controller,所以 @RestController 与 @Controller 的区别就是,@Controller返回的是ViewAndModel,@RestController返回的是字符串直接发送回给客户端。
- @RestController 源码声明:
@Target(value=TYPE)
@Retention(value=RUNTIME)
@Documented
@Controller
@ResponseBody
public @interface RestController
- @EnableAutoConfiguration 注解是类级别的,这个注解告诉Spring Boot“猜测”将如何配置Spring,它是基于添加的jar依赖。
Bean扫描机制-概览
<beans ...>
<context:component-scan base-package="a.b" name-generator="a.SimpleNameGenerator"/>
</beans>
- 先配置扫描地址,当一个 Bean 被自动检测到时,会根据那个扫描器的 BeanNameGenerator 策略生成它的 bean 名称。
- 默认情况下,对于包含 name 属性的 @Component、@Repository、 @Service 和 @Controller,会把 name 取值作为 Bean 的名字。
- 如果这个注解不包含 name 值或是其他被自定义过滤器发现的组件,默认 Bean 名称会是小写开头的非限定类名。
- 如果你不想使用默认 bean 命名策略,可以提供一个自定义的命名策略。首先实现 BeanNameGenerator 接口,确认包含了一个默认的无参数构造方法。然后在配置扫描器时提供一个全限定类名,如上代码。
- 通过上述注解标识的 Bean,其默认作用域是"singleton"。
Bean扫描机制-详解
- Spring中,管理注解Bean定义的容器有两个:AnnotationConfigApplicationContext和 AnnotationConfigWebApplicationContex。
- 这两个类是专门处理Spring注解方式配置的容器,直接依赖于注解作为容器配置信息来源的IoC容器。
javax.persistence下的注解
- @Entity 说明此java类是实体类 ,与数据库表一一对应
- @Id 表明主键
Lombok
- @Data
- @Getter
Hibernate
- @DynamicUpdate 表示在更新时只会操作有改变的值,不会所有属性的值都再写一边。
jackson
- @JsonProperty ,指定返回JSON数据时的一个名称
网友评论