SpringBoot 注解超全详解--一篇足够

发布时间:2024年01月09日

????????Java注解(Annotation)是一种元数据,它提供了一种在源代码中嵌入信息的方式。使用Java注解可以带来多方面的优点,包括:

  1. 代码优雅: 注解可以使代码更加简洁和优雅。通过在代码中添加注解,可以将一些元数据信息直接嵌入到代码中,而不需要繁琐的配置文件或其他外部资源。

  2. 提高开发效率: 注解能够减少开发者的工作量。通过使用现有的注解,可以快速地实现一些通用的功能,如日志记录、数据校验等,而不必手动编写大量重复性代码。

  3. 代码维护性: 注解使得代码更具可读性和可维护性。通过在代码中直接标注关键信息,可以使其他开发者更容易理解和维护代码,而不必深入研究各种配置文件。

  4. 编译时检查: 注解可以在编译时进行检查,提前发现潜在的问题。这有助于减少运行时错误,提高代码的健壮性。

  5. 框架集成: 注解在很多框架中得到了广泛应用,如Spring框架、JUnit等。通过使用框架提供的注解,可以更方便地实现一些功能,同时也使得代码与框架更好地集成。

  6. 元数据标记: 注解本身就是一种元数据标记的方式,可以用于标记类、方法、字段等各种程序元素。这些标记可以被其他工具或框架读取和利用,实现更灵活的处理逻辑。

总体而言,Java注解提供了一种轻量级且强大的方式来为代码添加元数据信息,提高了代码的可读性、可维护性,并在一定程度上降低了开发和维护的难度。

接下来的时间,我们来讲讲Spring Boot相关的注解!

1.@SpringBootApplication

@SpringBootApplication:申明让spring boot自动给程序进行必要的配置,这个配置等同于:@Configuration@EnableAutoConfiguration @ComponentScan 三个配置。

2.@ResponseBody

@ResponseBody:表示该方法的返回结果直接写入HTTP 的response body中,一般在异步获取数据时使用,用于构建RESTful的api。在使用@RequestMapping后,返回值通常解析为跳转路径,加上@Responsebody后返回结果不会被解析为跳转路径,而是直接写入HTTP response body中。比如异步获取json数据,加上@Responsebody后,会直接返回json数据。该注解一般会配合@RequestMapping一起使用。

3.@Controller

@Controller:用于定义控制器类,在Spring项目中由控制器负责将用户发来的URL请求转发到对应的服务接口(service层),一般这个注解在类中,通常方法需要配合注解@RequestMapping

4.@RestController

@RestController:用于标注控制层组件(如struts中的action),@ResponseBody@Controller的合集。

5.@RequestMapping

@RequestMapping:提供路由信息,负责URL到Controller中的具体函数的映射。

6.?@EnableAutoConfiguration

@EnableAutoConfiguration:SpringBoot自动配置(auto-configuration):尝试根据你添加的jar依赖自动配置你的Spring应用。例如,如果你的classpath下存在HSQLDB,并且你没有手动配置任何数据库连接beans,那么我们将自动配置一个内存型(in-memory)数据库。你可以将@EnableAutoConfiguration或者@SpringBootApplication注解添加到一个@Configuration类上来选择自动配置。如果发现应用了你不想要的特定自动配置类,你可以使用@EnableAutoConfiguration注解的排除属性来禁用它们。

7.?@ComponentScan

@ComponentScan:表示将该类自动发现扫描组件。

个人理解相当于,如果扫描到有@Component@Controller@Service等这些注解的类,并注册为Bean,可以自动收集所有的Spring组件,包括@Configuration类。我们经常使用@ComponentScan注解搜索beans,并结合@Autowired注解导入。如果没有配置的话,Spring Boot会扫描启动类所在包下以及子包下的使用了@Service,@Repository等注解的类。

8.?@Configuration

@Configuration:相当于传统的xml配置文件,如果有些第三方库需要用到xml文件,建议仍然通过@Configuration类作为项目的配置主类——可以使用@ImportResource注解加载xml配置文件

9.?@Import

@Import:用来导入其他配置类。

10.@ImportResource

@ImportResource:用来加载xml配置文件。

11.@Autowired

@Autowired:自动导入依赖的bean

12.@Service

@Service:一般用于修饰service层的组件

13.@Repository

@Repository:使用@Repository注解可以确保DAO或者repositories提供异常转译,这个注解修饰的DAO或者repositories类会被ComponetScan发现并配置,同时也不需要为它们提供XML配置项。

14.@Bean

@Bean:相当于XML中的,放在方法的上面,而不是类,意思是产生一个bean,并交给spring管理。

15.@Value

@Value:注入Spring boot application.properties配置的属性的值。

16.?@Inject

@Inject:等价于默认的@Autowired,只是没有required属性;

17.?@Component

@Component:泛指组件,当组件不好归类的时候,我们可以使用这个注解进行标注。

18.@AutoWired

@AutoWired:自动导入依赖的bean。默认byType方式。把配置好的Bean拿来用,完成属性、方法的组装,它可以对类成员变量、方法及构造函数进行标注,完成自动装配的工作。当加上(required=false)时,就算找不到bean也不报错。

19.@Qualifier

@Qualifier:当有多个同一类型的Bean时,可以用@Qualifier(“name”)来指定。与@Autowired配合使用。@Qualifier限定描述符除了能根据名字进行注入,但能进行更细粒度的控制如何选择候选者。

20.@Resource

@Resource(name=”name”,type=”type”):没有括号内内容的话,默认byName。与@Autowired干类似的事。

21.@SpringBootApplication

@SpringBootApplication:包含了@ComponentScan@Configuration@EnableAutoConfiguration注解。

22.?@PathVariable

@PathVariable:获取参数。

23.@JsonBackReference

@JsonBackReference:解决嵌套外链问题。

24.@RepositoryRestResourcepublic

@RepositoryRestResourcepublic:配合spring-boot-starter-data-rest使用。

---------------------------------------------------------------------------------------------------------------------------------

25.@Entity

@Entity@Table(name=""):表明这是一个实体类。一般用于jpa这两个注解一般一块使用,但是如果表名和实体类名相同的话,@Table可以省略

26.@MappedSuperClass

@MappedSuperClass:用在确定是父类的entity上。父类的属性子类可以继承。

27.@NoRepositoryBean

@NoRepositoryBean:一般用作父类的repository,有这个注解,spring不会去实例化该repository。

28.@Column

@Column:如果字段名与列名相同,则可以省略。

29.@Id

@Id:表示该属性为主键。

30.@GeneratedValue

@GeneratedValue(strategy = GenerationType.SEQUENCE,generator = “repair_seq”):表示主键生成策略是sequence(可以为Auto、IDENTITY、native等,Auto表示可在多个数据库间切换),指定sequence的名字是repair_seq。

31.?@SequenceGeneretor

@SequenceGeneretor(name = “repair_seq”, sequenceName = “seq_repair”, allocationSize = 1):name为sequence的名称,以便使用,sequenceName为数据库的sequence名称,两个名称可以一致。

32.@Transient

@Transient:表示该属性并非一个到数据库表的字段的映射,ORM框架将忽略该属性。如果一个属性并非数据库表的字段映射,就务必将其标示为@Transient,否则,ORM框架默认其注解为@Basic。@Basic(fetch=FetchType.LAZY):标记可以指定实体属性的加载方式。

33.@JsonIgnore

@JsonIgnore:作用是json序列化时将Java bean中的一些属性忽略掉,序列化和反序列化都受影响。

34.@JoinColumn

@JoinColumn(name=”loginId”):一对一本表中指向另一个表的外键。一对多:另一个表指向本表的外键。

35.@OneToOne、@OneToMany、@ManyToOne

@OneToOne、@OneToMany、@ManyToOne:对应hibernate配置文件中的一对一,一对多,多对一。

36.@RequestMapping

@RequestMapping:@RequestMapping(“/path”)表示该控制器处理所有“/path”的UR L请求。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)类型中包含该指定类型才返回

37.@RequestParam

@RequestParam:用在方法的参数前面。

38.@PathVariable

@PathVariable:路径变量。

全局异常处理

39.@ControllerAdvice

@ControllerAdvice:包含@Component。可以被扫描到。统一处理异常。

?40.@ExceptionHandler

@ExceptionHandler(Exception.class):用在方法上面表示遇到这个异常就执行以下方法。

?

文章来源:https://blog.csdn.net/zoroly/article/details/135485836
本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。