一:SpringBoot/Spring
注解 | 注解解析 |
@SpringBootApplication | 该注解包含了@Configuration,@EnableAutoConfiguration以及@ComponentScan注解,通常使用在主类上。 |
@Repository | 用户标注数据库访问组件(接口),及DAO组件(接口)。 |
@Service | 用于标注业务层组件。 |
@RestController | 用于标注控制层组件(如Struts中的action),包含@Controlle以及@ResponseBody,请求相应的结果最终以Json格式返回。 |
@Controller | 用于标注控制层组件,需要返回页面时使用的注解。 |
@Component | 泛指组件,当组件不好归类的时候,我们可以使用这个注解进行标注。 |
@ResponseBody | 表示该方法的返回结果直接写入HTTP response body中,一般在异步获取数据时使用,在使用@RequestMapping后,返回值通常解析为跳转路径。加上@ResponseBody后返回结果不会被解析为跳转路径,而是直接写入HttpResponseBody中,比如异步获取Json数据时,加上@ResponseBody后,回直接返回json数据。 |
@RequestBody | 参数前加上这个注解之后,默认参数必填。表示接受的json字符串转为对象。 |
@ComponentScan | 组件扫描,如果存在@Component @Controller @Service等这些注解的累,被扫描后,就会将这些累注册为一个bean |
@Bean | 相当于在XML中,放在方法上并非类上,目的是产生一个bean,并交给Spring进行管理 |
@Configuration | 指出该类是Bean的配置信息源,相当于在XML中,一般加载主类上。 |
@EnableAutoConfigration | 让SpringBoot根据应用所声明的依赖来对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();请求路径如:https://www.baidu.com?macAddress=b public String getByMacAddress( |
@PathVariable | 同样用在方法的参数前面,如RequestMapping(“user/get/mac/{macAddress}”) ; public String getByMacAddress( 请求的路径:https://www.baidu.com/user/get/mac/macAddress的值。 参数与大括号中的名字相同的话,注解后括号里的内容可以不填。 |
二: JPA
注解 | 注解的解释 |
@Entity @Table(name = " ") | 这两个注解一般一起使用来表明一个实体类,但是如果表名和实体类名相同的话,@Table可以省略。 |
@MappedSuperClass | 用来确定父类的entity上,父类的属性子类可以继承。 |
@NoRepositoryBean | 一般用作父类的repository,该注解是的spring不会去实例化该repository。 |
@Column | 如果字段名与数据库中列名相同,可以省略,如果不相同该注解指定字段名与数据库列名之间的映射。 |
@Id | 表示该属性为相对应表中的主键 |
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "repair_seq") | 表明主键生成策略是sequence(可以为Auto(表示多个数据库之间切换),IDENTITY,native等),指定sequence的名字是repair_seq; |
@SequenceGenerator(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中的一些属性忽略掉,序列化和反序列化都受影响。 |
@JoinConlumn(name = "IoginId") | 一对一:本表中指向另一个表的外键 一对多:另一个表指向本表的外键 |
@OneToOne @OneToMany @ManyToOne | 对应Hibernate配置文件中的一对一,一对多,多对一 |
三:全局异常处理注解
注解 | 注解解释 |
@ControllerAdvice | 包含@Component.可以被扫描到。捕获controller层的异常进行统一处理; |
@ExceptionHandler(Exception.class) | 用在方法方法上表示遇到这个异常就会执行一下方法。 |
四: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注解是三者的组合注解,能够达到三者同等的效果。 |
总结:红色字体表示不经常使用的但是我们应该了解到注解!