Spring Boot 常用注解

最新推荐文章于 2024-04-15 11:40:11 发布

输了起点，我们还有拐点。

最新推荐文章于 2024-04-15 11:40:11 发布

阅读量884

点赞数 6

本文链接：https://blog.csdn.net/weixin_42765634/article/details/119241441

版权

Spring Boot注解篇专栏收录该内容

1 篇文章 0 订阅

订阅专栏

40 个 Spring Boot 常用注解

Spring Boot 常用注解

Spring Boot 常用注解

Spring boot 之所以简单，是因为减少了xml相关的配置文件，使用注解形式进行自动注入。所以注解是Spring Boot 开发简单原因之一，下面我们根据不同的框架和功能分开统计相关注解。

一、SpringMVC和Spring Bean的注解

Spring Web MVC 注解

@RequestMapping

@RequestMapping注解的主要用途是将web请求与请求处理类中的方法映射。其中RequestMappingHandlerMapping和RequestMappingHandlerAdapter两个类提供对@RequestMapping注解的支持,可用于类上、方法上。
@RequestMapping有6个配置属性。

value:映射的请求URL
mothod:兼容HTTP的方法名（get\post）方式请求。其在spring boot中可用@GetMapping@PostMapping进行替换。
params:根据HTTP参数的存在、缺省或值对请求进行过滤。
header:根据HTTP Header的存在、缺省或值对请求进行过滤。
consume:设定在HTTP请求正文中允许使用的媒体类型。
product:在HTTP响应体中允许使用的媒体类型
以上6个属性前三个最常用，以下示例类上和方法上

@RequestBody

@RequsetBody在处理方法的参数列表中使用，可用将请求体中的参数绑定到一个对象中（也就是常说的实体类）

 @RequestMapping(value = "/test", method = RequestMethod.GET)
    public User testBody(@RequestBody User user){
        return user;
    }

@GetMapping

@GetMapping注解用于处理HTTP GET请求，并将请求映射到具体的处理方法中。具体来说，@GetMapping是一个组合注解，它相当于是@RequestMapping(method=RequestMethod.GET)的快捷方式

@PostMapping

@PostMapping注解用于处理HTTP POST请求，并将请求映射到具体的处理方法中。@PostMapping与@GetMapping一样，也是一个组合注解，它相当于是@RequestMapping(method=HttpMethod.POST)的快捷方式。

@PutMapping

@PutMapping注解用于处理HTTP PUT请求，并将请求映射到具体的处理方法中，@PutMapping是一个组合注解，相当于是@RequestMapping(method=HttpMethod.PUT)的快捷方式。
@putMapping示例

@DeleteMapping

@DeleteMapping注解用于处理HTTP DELETE请求，并将请求映射到删除方法中。@DeleteMapping是一个组合注解，它相当于是@RequestMapping(method=HttpMethod.DELETE)的快捷方式。
DeleteMapping示例

@ControllerAdvice

@ControllerAdvice是@Component注解的一个延伸注解，Spring会自动扫描并检测被@ControllerAdvice所标注的类。使用@ControllerAdvice注解，就可以快速的创建统一的，自定义的异常处理类。

@ResponseBody

@ResponseBody作用在collect层的方法上，是接口要返回json类型的数据。
相当于@RestController

@PathVariable

@PathVariable注解是将方法中的参数绑定到请求URL中的模板变量上。可用通过@RequestMapping注解来指定URL的模板变了。然后使用@PathVariable注解将方法中的参数绑定到模板变量上。可以使用value或者name属性给参数取一个别名。

 @GetMapping("/test/{id}/role/{roleId}")
    public String testBody(@PathVariable(name ="id") long useId,@PathVariable(value = "roleId") long roleId){
        return "user";
    }

模板变量名需要使用“{ }”进行包裹，如果方法的参数名与URI模板变量名一致，则在@PathVariable中就可以省略别名的定义。

@GetMapping("/test/{id}/role/{roleId}")
    public String testBody(@PathVariable long id,@PathVariable long roleId){
        return "user";
    }

提示：如果参数是一个非必须的，可选的项，则可以在@PathVariable中设置require = false

@RequestParam

@RequestParam注解用于将方法的参数与Web请求的传递的参数进行绑定。使用@RequestParam可以轻松的访问HTTP请求参数的值。

@GetMapping("/test/param")
    public void testParam(@RequestParam(name = "id") long id){
        
    }

该注解的其他属性配置与@PathVariable的配置相同，特别的，如果传递的参数为空，还可以通过defaultValue设置一个默认值

@GetMapping("/test/param")
    public void testParam(@RequestParam(name = "id",defaultValue = "0") long id){

    }

@Controller

这个就不多解释了，有此注解的类是控制类。也就是控制层。

@RestController

@RestController是在Spring 4.0开始引入的，这是一个特定的控制器注解。此注解相当于@Controller和@ResponseBody的快捷方式。当使用此注解时，不需要再在方法上使用@ResponseBody注解。

@ModelAttribute

通过此注解，可以通过模型索引名称来访问已经存在于控制器中的model。其实也是一个数据绑定。

@GetMapping("/test/model")
    public void saveUser(@ModelAttribute(name = "user") User user){
        userService.save(user);
    }

因为名称是一样的，所以(name = “user”)可以去掉。
如果使用@ModelAttribute对方法进行标注，Spring会将方法的返回值绑定到具体的Model上。

在Spring调用具体的处理方法之前，被@ModelAttribute注解标注的所有方法都将被执行。

@ModelAttribute("User")
    public User getUser(){
        User user = new User();
        user.setAge(12);
        user.setName("张三");
        return user;
    }

@CrossOrigin

@CrossOrigin注解将为请求处理类或请求方法提供跨域调用支持。
如果我们将此注解标注类，那么类中的所有方法都将获得支持跨域的能力。使用此注解的好处是可以微调跨域行为。

 	@CrossOrigin
    @GetMapping("/test/model")
    public void saveUser(@ModelAttribute(name = "user") User user){
        userService.save(user);
    }

二、Spring Bean 注解

主要列举与Spring Bean相关的4个注解以及它们的使用方式。

@ComponentScan

@ComponentScan注解用于配置Spring需要扫描作为组件的类所在的包。可以通过basePackages属性或value属性来配置需要扫描的路径。

@Configuration
@ComponentScan(basePackageClasses = "com.aaa")
public class testConfig {
    
}

@Component

@Component注解用于标注一个普通的组件类，只是通知spring被此注解的类需要加入到spring bean容器中并进行管理。

@Service

@Service注解是@Component的一个延伸（特例），它用于标注业务逻辑类。与@Component注解一样，被此注解标注的类，会自动被Spring所管理。就不写示例了。经常写逻辑层的都知道。

@Controller

这个其实也是的。

三、Spring Dependency Inject 与 Bean Scops注解

Spring DI注解

@Bean

@Bean注解主要作用是告知Spring,被此注解标注的类或方法需要纳入到Bean管理工厂中。
注册一个组件类

加入spring容器管理

@Bean
public RestTemplate restTemplate(){
	return new RestTemplate 
}

@Scops注解

@Scops注解用来定义@Component标注的类作用范围以及@Bean所标记的作用范围。
@Scops作用范围有：singleton、prototype、request、session、globalSession
以prototype为例，当一个Spring Bean被声明为prototype时，每次用到该类的时候，Spring Ioc容器都会初始化一个新的该类的实例。在定义一个Bean时，可以设置Bean的scope属性为prototype. scope=“prototype”,也可以使用注解形式设置

@Scope(value=ConfigurableBeanFactory.SCOPE_PROPTOTYPE)

@Scope 单例模式

当@Scope的作用范围设置成Singleton时，被此注解所标注的类只会被Spring IoC容器初始化一次。在默认情况下，Spring IoC容器所初始化的类实例都为singleton。同样的原理，此情形也有两种配置方式，示例代码如下：
单例示例

四、容器配置注解

@Autowired

@Autowired注解用于标记Spring将要解析和注入的依赖项。此注解可以作用在构造函数、字段和setter方法上。
作用于构造函数

@RestController
public class userController{
	private UserService userService;
	@Autowired
	userController(UserService userService){
	this.userService = userService;
	}
}

作用于setter方法

下面是@Autowired注解标注setter方法的示例代码：

@RestController
public class userController{
	private UserService userService;
	@Autowired
	public void setUserService(UserService userService){
	this.userService = userService;
	}
}

作用于字段
@Autowired注解标注字段是最简单的，只需要在对应的字段上加入此注解即可

@RestController
public class userController{
	
	@Autowired
	private UserService userService;
}

@Primary

当系统中需要配置多个具有相同类型的bean时，@Primary可以定义这些Bean的优先级.
@Primary优先级
输出结果

this is send DingDing method message.

@PostConstruct与@PreDestroy

这两个注解不属于Spring,它们是源于JSR-250中的两个注解，位于common-annotations.jar中。@PostConstruct注解用于标注在Bean被Spring初始化之前需要执行的方法。@PreDestroy注解用于标注Bean被销毁前需要执行的方法。

@PostConstruct与@preDestroy示例

@Qualifier

当系统中存在同一类型的多个Bean时，@Autowired在进行依赖注入的时候不知道选择哪一个实现类进行注入。我们可以用@Qualifier进行标识。选择依赖项。

五、Spring Boot注解

其实Spring Boot自己注解使用很少，常用就几个

@SpringBootApplication

@SpringBootApplication标记一个启动类。此注解相当于@Configuration、@EnableAutoConfiguration和@ComponentScan的组合

@EnableAutoConfiguration

@EnableAutoConfiguration注解用于通知spring，根据当前类路径下引用依赖包，自动配置与这些依赖包相关的配置项。

@ConditionalOnClass与@ConditionalOnMissingClass

这两个注解属于类条件注解，它们根据是否存在某个类作为判断依据来决定是否要执行某些配置。


@Configuration
@ConditionalOnClass(DataSource.class)
class MySQLAutoConfiguration {
 //...
}

@ConditionalOnBean与@ConditionalOnMissingBean

这两个注解属于对象条件注解，根据是否存在某个对象作为依据来决定是否要执行某些配置方法。


@Bean
@ConditionalOnBean(name="dataSource")
LocalContainerEntityManagerFactoryBean entityManagerFactory(){
 //...
}
@Bean
@ConditionalOnMissingBean
public MyBean myBean(){
 //...
}

@ConditionalOnProperty

@ConditionalOnProperty注解会根据Spring配置文件中的配置项是否满足配置要求，从而决定是否要执行被其标注的方法。示例代码如下：

@Bean
@ConditionalOnProperty(name="alipay",havingValue="on")
Alipay alipay(){
 return new Alipay();
}

@ConditionalOnResource

此注解用于检测当某个配置文件存在时，则触发被其标注的方法，下面是使用此注解的代码示例：


@ConditionalOnResource(resources = "classpath:website.properties")
Properties addWebsiteProperties(){
 //...
}

@ConditionalOnWebApplication与@ConditionalOnNotWebApplication

这两个注解用于判断当前的应用程序是否是Web应用程序。如果当前应用是Web应用程序，则使用Spring WebApplicationContext,并定义其会话的生命周期。


@ConditionalOnWebApplication
HealthCheckController healthCheckController(){
 //...
}

@ConditionalExpression

此注解可以让我们控制更细粒度的基于表达式的配置条件限制。当表达式满足某个条件或者表达式为真的时候，将会执行被此注解标注的方法。


@Bean
@ConditionalException("${localstore} && ${local == 'true'}")
LocalFileStore store(){
 //...
}

@Conditional

@Conditional注解可以控制更为复杂的配置条件。在Spring内置的条件控制注解不满足应用需求的时候，可以使用此注解定义自定义的控制条件，以达到自定义的要求。

@Conditioanl(CustomConditioanl.class)
CustomProperties addCustomProperties(){
 //...
}

总结

这些基本是在使用Spring Boot常用的注解了，具体的使用方式，有不对的地方，请各位大神指教。

输了起点，我们还有拐点。

关注

6
点赞
踩
15

收藏

觉得还不错? 一键收藏
0
评论
Spring Boot 常用注解

40 个 Spring Boot 常用注解Spring Boot 常用注解一、SpringMVC和Spring Bean的注解Spring Web MVC 注解@RequestMapping@RequestBody@GetMapping@PostMapping@PutMapping@DeleteMapping@ControllerAdvice@ResponseBody@PathVariable@RequestParam@Controller@RestController@ModelAttribute@Cro
复制链接

扫一扫