spring/spring boot/spring mvc中用到的注解
在spring Boot中几乎可以完全弃用xml配置文件,本文的主题是分析常用的注解。
Spring最开始是为了解决EJB等大型企业框架对应用程序的侵入性,因此大量依靠配置文件来“非侵入式”得给POJO增加功能,然而,从Spring 3.x开始,Spring被外界最为诟病的一点就是配置繁多,号称“配置地狱”,各种xml文件,出了问题非常难排查。从Spring 4.x开始,Spring.io提供了三种方式编织Bean:
- 利用注解:隐式配置,例如:@Autowired、@Bean、@Component等,通过注解来简化xml文件。
- 利用Java文件:显示配置,比xml配置的优势是具备类型安全
- 利用传统的xml配置文件
注解(annotations)列表
- @ResponseBody
用该注解修饰的函数,会将结果直接填充到HTTP的响应体中,一般用于构建RESTful的api; - @Controller
用于定义控制器类,在spring 项目中由控制器负责将用户发来的URL请求转发到对应的服务接口(service层)。 - @RestController
@ResponseBody和@Controller的合集 - @RequestMapping
提供路由信息,负责URL到Controller中的具体函数的映射。 - @EnableAutoConfiguration
Spring Boot自动配置(auto-configuration):尝试根据你添加的jar依赖自动配置你的Spring应用。例如,如果你的classpath下存在HSQLDB,并且你没有手动配置任何数据库连接beans,那么我们将自动配置一个内存型(in-memory)数据库”。你可以将@EnableAutoConfiguration或者@SpringBootApplication注解添加到一个@Configuration类上来选择自动配置。如果发现应用了你不想要的特定自动配置类,你可以使用@EnableAutoConfiguration注解的排除属性来禁用它们。例子代码如下: - @ComponentScan
表示将该类自动发现(扫描)并注册为Bean,可以自动收集所有的Spring组件,包括@Configuration类。我们经常使用@ComponentScan注解搜索beans,并结合@Autowired注解导入。 - @Configuration
相当于传统的xml配置文件,如果有些第三方库需要用到xml文件,建议仍然通过@Configuration类作为项目的配置主类——可以使用@ImportResource注解加载xml配置文件。 - @SpringBootApplication
相当于@EnableAutoConfiguration、@ComponentScan和@Configuration的合集。 - @Import
用来导入其他配置类。 - @ImportResource
用来加载xml配置文件。 - @Autowired
自动导入依赖的bean - @Service
一般用于修饰service层的组件 - @Repository
使用@Repository注解可以确保DAO或者repositories提供异常转译,这个注解修饰的DAO或者repositories类会被ComponetScan发现并配置,同时也不需要为它们提供XML配置项。 - @Qualifier:
当有多个同一类型的Bean时,可以用@Qualifier("name")来指定。与@Autowired配合使用 - @Resource(name="name",type="type"):
没有括号内内容的话,默认byName。与@Autowired干类似的事。 - @Entity:
@Table(name=""):
表明这是一个实体类。一般用于jpa
这两个注解一般一块使用,但是如果表名和实体类名相同的话,@Table可以省略 - @MappedSuperClass:
用在确定是父类的entity上。父类的属性子类可以继承。 - @NoRepositoryBean:
一般用作父类的repository,有这个注解,spring不会去实例化该repository。 - @Column:
如果字段名与列名相同,则可以省略。 - @Id:
表示该属性为主键。 - @GeneratedValue(strategy = GenerationType.SEQUENCE,generator = "repair_seq"):
表示主键生成策略是sequence(可以为Auto、IDENTITY、native等,Auto表示可在多个数据库间
切换),指定sequence的名字是repair_seq。 - @SequenceGeneretor(name = "repair_seq", sequenceName = "seq_repair", allocationSize = 1)
name为sequence的名称,以便使用,sequenceName为数据库的sequence名称,两个名称可以一致。 - @Transient:
表示该属性并非一个到数据库表的字段的映射,ORM框架将忽略该属性.
如果一个属性并非数据库表的字段映射,就务必将其标示为@Transient,否则,ORM框架默认其注解为@Basic - @Basic(fetch=FetchType.LAZY):
标记可以指定实体属性的加载方式 - @JsonIgnore:
作用是json序列化时将java bean中的一些属性忽略掉,序列化和反序列化都受影响。 - @JoinColumn(name="loginId"):
一对一:本表中指向另一个表的外键。
一对多:另一个表指向本表的外键。
@OneToOne
@OneToMany
@ManyToOne
对应Hibernate配置文件中的一对一,一对多,多对一。 - @RequestMapping:
RequestMapping是一个用来处理请求地址映射的注解,可用于类或方法上。用于类上,表示类中
的所有响应请求的方法都是以该地址作为父路径。
该注解有六个属性:
params:指定request中必须包含某些参数值是,才让该方法处理。
headers:指定request中必须包含某些指定的header值,才能让该方法处理请求。
value:指定请求的实际地址,指定的地址可以是URI Template 模式
method:指定请求的method类型, GET、POST、PUT、DELETE等
consumes:指定处理请求的提交内容类型(Content-Type),如application/json,text/html;
produces:指定返回的内容类型,仅当request请求头中的(Accept)类型中包含该指定类型才返回 - @RequestParam:
用在方法的参数前面。
@RequestParam String a =request.getParameter("a")。 - @PathVariable:
路径变量。
如 RequestMapping("user/get/mac/{macAddress}")
public String getByMacAddress(@PathVariable String macAddress){
//do something;
}
参数与大括号里的名字一样要相同。 - 全局异常处理
@ControllerAdvice:
包含@Component。可以被扫描到。
统一处理异常。 - @ExceptionHandler(Exception.class):
用在方法上面表示遇到这个异常就执行以下方法。 - @Bean:
相当于XML中的<bean></bean>,放在方法的上面,而不是类,意思是产生一个bean,并交给spring
管理。