一. Spring/SpringBoot相关注解
-
@SpringBootApplication
:包含@Configuration
、@EnableAutoConfiguration
、@ComponentScan
通常用在主类上;-
@Repository
:用于标注数据访问组件,即DAO组件;-
@Service
:用于标注业务层组件;- @PostConstruct:初始化方法
- @PreDestroy:销毁方法
- @Transactional:Spring中用来控制事务
-
@RestController:
用于标注控制层组件(如struts中的action),包含@Controller
和@ResponseBody
;-
@Controller
:用于标注是控制层组件,需要返回页面时请用@Controller
而不是@RestController
;-
@Component
:泛指组件,当组件不好归类的时候,可以使用这个注解进行标注;-
@ResponseBody
:表示该方法的返回结果直接写入HTTP response body中,一般在异步获取数据时使用,在使用@RequestMapping
后,返回值通常解析为跳转路径,加上@ResponseBody
后返回结果不会被解析为跳转路径,而是直接写入HTTP response body中;比如异步获取json数据,加上@ResponseBody
后,会直接返回json数据;-
@RequestBody
:参数前加上这个注解之后,认为该参数必填。表示接受json字符串转为对象 List等;-
@ComponentScan
:组件扫描。如果扫描到有@Component
@Controller
@Service
等这些注解的类,则把这些类注册为bean*;-
@Configuration
:指出该类是 Bean 配置的信息源,相当于XML中的,一般加在主类上;-
@Bean
:相当于XML中的,放在方法的上面,而不是类,意思是产生一个bean,并交给spring管理;-
@EnableAutoConfiguration
:让 Spring Boot 根据应用所声明的依赖来对 Spring 框架进行自动配置,一般加在主类上;-
@AutoWired
:byType方式。把配置好的Bean拿来用,完成属性、方法的组装,它可以对类成员变量、方法及构造函数进行标注,完成自动装配的工作;当加上(required=false)时,就算找不到bean也不报错;-
@Qualifier
:当有多个同一类型的Bean时,可以用@Qualifier("name")
来指定。与@Autowired
配合使用;-
@Resource(name="name",type="type")
:没有括号内内容的话,默认byName。与@Autowired干类似的事;-
@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)类型中包含该指定类型才返回。
-
@GetMapping
、@PostMapping
等:相当于@RequestMapping(value="/",method=RequestMethod.Get\Post\Put\Delete
等) 。是个组合注解;-
@RequestParam
:用在方法的参数前面。相当于 request.getParameter()
;-
@PathVariable
:路径变量。如RequestMapping("user/get/mac/{macAddress}") public String getByMacAddress(@PathVariable("macAddress") String macAddress){ //do something; }
参数与大括号里的名字相同的话,注解后括号里的内容可以不填。
二. 切面相关注解
- @Aspect:标识当前类是一个切面类
- @Pointcut:用于定义切入点表达式 表达式写法4种
- @EnableAspectJAutoProxy:让AOP的注解有效果
- @Before:AOP前置通知
- @AfterReturning:AOP后置通知
- @AfterThrowing:AOP异常通知
- @After:AOP最终通知
- @Around:AOP环绕通知
三. JPA相关注解
-
@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配置文件中的一对一,一对多,多对一。
四. 全局异常处理注解
-
@ControllerAdvice
:包含@Component
。可以被扫描到。统一处理异常;-
@ExceptionHandler(Exception.class)
:用在方法上面表示遇到这个异常就执行以下方法。
五. Mybatis相关注解
- @Mapper:Mybatis将当前的接口交给Spring容器管理. Map<类名小写,JDK动态代理对象
- @SpringBootTest:该注解的作用在进行代码测试时启动spring容器,之后动态的获取对象 注意包路径 主启动类的同包及子包中;
- @Param:Mybatis中将参数封装为Map集合;
- @Alias:Mybatis中定义对象的别名
- @Alias(“User”):设置别名;
- @MapperScan:Mybatis中扫描指定包路径的接口 为其创建代理对象.
- @Insert:Mybatis 新增操作注解
- @Update:Mybatis 修改操作注解
- @Delete:Mybatis 删除操作注解
- @Select:Mybatis 查询操作注解
六. SpringCloud相关注解
-
@EnableEurekaServer
:用在SpringBoot启动类上,表示这是一个eureka服务注册中心;-
@EnableDiscoveryClient
:用在SpringBoot启动类上,表示这是一个服务,可以被注册中心找到;-
@LoadBalanced
:开启负载均衡能力;-
@EnableCircuitBreaker
:用在启动类上,开启断路器功能;-
@HystrixCommand(fallbackMethod="backMethod")
:用在方法上,fallbackMethod指定断路回调方法;-
@EnableConfigServer
:用在启动类上,表示这是一个配置中心,开启Config Server;-
@EnableZuulProxy
:开启zuul路由,用在启动类上;-
@SpringCloudApplication
:内部包含@SpringBootApplication、
@EnableDiscovertyClient和@EnableCircuitBreaker
:分别是SpringBoot注解、注册服务中心Eureka注解、断路器注解。对于SpringCloud来说,这是每一微服务必须应有的三个注解,所以才推出了@SpringCloudApplication
这一注解集合。