查看原文
其他

Spring Boot从入门到精通(三)常用注解含义及用法分析总结

素文宅博客 Java精选 2022-08-09

Spring Boot是目前非常流行的框架,而注解是Spring Boot的核心功能,接下来主要说一说Spring Boot常用注解的含义以及部分注解在项目中的使用方法。



@RestController和@RequestMapping

@RestController被称为一个构造型(stereotype)注解。它为阅读代码的开发人员提供建议。对于Spring来说,该类扮演了一个特殊角色。它继承自@Controller注解。


在Spring4.0之前的版本,Spring MVC的组件都使用@Controller来标识当前类是一个控制器servlet。使用这个特性,我们可以开发REST服务的时候不需要使用@Controller而专门的@RestController。


@RestController:@Controller和@ResponseBody的合集,用于标注控制层组件(如struts中的action),配置在controller层表示该控制层里面的方法是以json的格式进行输出。


在本实例中,Example的类是一个web @Controller,所以当处理进来的web请求时,Spring会询问它。实例代码如下:


import org.springframework.boot.*;import org.springframework.boot.autoconfigure.*;import org.springframework.stereotype.*;import org.springframework.web.bind.annotation.*;@RestController@EnableAutoConfigurationpublic class Example { @RequestMapping("/") String home() { return "Hello World!"; } public static void main(String[] args) throws Exception { SpringApplication.run(Example.class, args); }}


@RequestMapping:提供路由信息。此注解告诉Spring任何来自"/"路径的HTTP请求都应该被映射到home方法。@RestController注解告诉Spring以字符串的形式渲染结果,并直接返回给调用者。该注解有六个属性: 


params,指定request中必须包含某些参数值是,才让该方法处理;


headers,指定request中必须包含某些指定的header值,才能让该方法处理请求;


value,指定请求的实际地址,指定的地址可以是URI Template 模式;


method,指定请求的method类型, GET、POST、PUT、DELETE等;


consumes,指定处理请求的提交内容类型(Content-Type),如application/json,text/html;


produces,指定返回的内容类型,仅当request请求头中的(Accept)类型中包含该指定类型才返回。


在本实例中,请求test方法渲染结果后返回给调用者。实例代码如下:


@RequestMapping("/test") @ResponseBody public String test(){ return "欢迎关注“Java精选”公众号,Spring Boot从入门到精通,持续更新中"; }


注意:@RestController和@RequestMapping注解是Spring MVC注解(它们不是Spring Boot的特定部分)。


@EnableAutoConfiguration

@EnableAutoConfiguration:尝试根据开发者添加的jar依赖自动配置Spring应用。


由于spring-boot-starter-web添加了Tomcat和Spring MVC,所以auto-configuration将假定正在开发一个web应用并相应地对Spring进行设置。


Starter POMs和Auto-Configuration设计auto-configuration的目的是更好的使用"Starter POMs",但这两个概念没有直接的联系。可以自由地挑选starter POMs以外的jar依赖,并且Spring Boot将仍旧尽最大努力去自动配置应用。


开发者可以通过将@EnableAutoConfiguration或@SpringBootApplication注解添加到一个@Configuration类上来选择自动配置。实例代码如下:


import org.springframework.boot.autoconfigure.*; import org.springframework.boot.autoconfigure.jdbc.*; import org.springframework.context.annotation.*; @Configuration @EnableAutoConfiguration(exclude={DataSourceAutoConfiguration.class}) public class MyConfiguration { // ... }


注意:只需要添加一个@EnableAutoConfiguration注解。建议将它添加到主@Configuration类上,如果发现应用不想要的特定自动配置类,可以使用@EnableAutoConfiguration注解的排除属性来禁用它们。


@Configuration

Spring Boot提倡基于Java的配置。尽管可以使用一个XML源来调用SpringApplication.run(),但官方建议使用@Configuration类作为主要源。


一般定义main方法的类也是主要@Configuration的一个很好候选。不需要将所有的@Configuration放进一个单独的类。


@Import:用来导入其他配置类,将class导入容器中。


@ComponentScan:注解自动收集所有的Spring组件,包括@Configuration类。


如果需要使用基于XML的配置,官方建议仍旧从一个@Configuration类开始。可以使用附加的@ImportResource注解加载XML配置文件。


@Configuration:等同于Spring的XML配置文件beans;用@Bean标注方法等价于XML中配置bean,使用Java代码可以检查类型安全。实例代码如下:


@ComponentScan(basePackages = "com.yoodb.blog",includeFilters = {@ComponentScan.Filter(Aspect.class)})


@ComponentScan:表示将该类自动发现扫描组件。如果扫描到有@Component、@Controller、@Service等这些注解的类,并注册为Bean,可以自动收集所有的Spring组件,包括@Configuration类。


使用@ComponentScan注解搜索beans,并结合@Autowired注解导入。可以自动收集所有的Spring组件,包括@Configuration类。如果没有配置,Spring Boot会扫描启动类所在包下以及子包下的使用了@Service,@Repository等注解的类。


@SpringBootApplication

大多数Spring Boot开发者总是使用@Configuration,@EnableAutoConfiguration和@ComponentScan注解他们的main类。由于这些注解被如此频繁地一起使用,Spring Boot提供一个方便的@SpringBootApplication选择。


@SpringBootApplication:注解等价于以默认属性使用@Configuration,@EnableAutoConfiguration和@ComponentScan。实例代码如下:


import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; //@SpringBootApplication 等同于//@Configuration @EnableAutoConfiguration @ComponentScan  public class Application { public static void main(String[] args) { SpringApplication.run(Application.class, args); } }


Spring Boot将尝试校验外部的配置,默认使用JSR-303(如果在classpath路径中)。可以轻松的为@ConfigurationProperties类添加JSR-303 javax.validation约束注解,实例代码如下:


@Component @ConfigurationProperties(prefix="connection") public class ConnectionSettings { @NotNull private InetAddress remoteAddress; // ... getters and setters }


@Profiles

Spring Profiles提供了一种隔离应用程序配置的方式,并让这些配置只能在特定的环境下生效。任何@Component或@Configuration都能被@Profile标记,从而限制加载它的时机。


@Profiles:在类或@bean注解的方法上可以实现不同的配置实例化不同的类,然后通过jvm参数来指定spring.profiles.active值就能做到运行切换配置环境。实例代码如下:


@Configuration @Profile("production") public class ProductionConfiguration { // ... }


全局异常处理

@ControllerAdvice是Spring3.2提供的新注解,它是一个Controller增强器,可对controller中被 @RequestMapping注解的方法加一些逻辑处理。最常用的就是异常处理。


@ControllerAdvice:包含@Component。可以被扫描到。统一处理异常。需要配合@ExceptionHandler使用。


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


全局异常处理,实例代码如下:


/** * 全局异常处理 */ @ControllerAdvice public class GlobalDefaultExceptionHandler { public static final String DEFAULT_ERROR_VIEW = "error"; @ExceptionHandler({TypeMismatchException.class,NumberFormatException.class}) public ModelAndView formatErrorHandler(HttpServletRequest req, Exception e) throws Exception { ModelAndView mav = new ModelAndView(); mav.addObject("error","参数类型错误"); mav.addObject("exception", e); mav.addObject("url", RequestUtils.getCompleteRequestUrl(req)); mav.addObject("timestamp", new Date()); mav.setViewName(DEFAULT_ERROR_VIEW); return mav; }}


@Value:将外部的值动态注入到Bean中,使用的情况包括有注入普通字符串;注入操作系统属性;注入表达式结果;注入其他Bean属性;注入文件资源;注入URL资源。


通过@value注解可以用于读取application.properties里面的配置,实例配置参考如下:


/************** application.properties *************/qq_api_key=********1***********qq_api_secrt=******2***********

/************* Java **************/@Value("${qq_api_key}") private String API_KEY;

@Value("${qq_api_secrt}") private String API_SECRET;


注意:使用@Value注解的时其使用的类如果被其他类作为对象引用,必须要使用注入的方式而不能new,一般常用的配置在application.properties文件。


@RequestParam

@RequestParam:用在方法的参数前面,将请求参数绑定到控制器的方法参数上是Spring MVC中接收普通参数的注解,@RequestParam(value="参数名",required="true/false",defaultValue=""),实例代码如下:


@RequestParam(value="name",required="true/false",defaultValue="")
@RequestParam String name =request.getParameter("name");


value,参数名;

 

required,是否包含该参数,默认为true,表示该请求路径中必须包含该参数,如果不包含就报错;

 

defaultValue,默认参数值,如果设置了该值,required=true将失效,自动为false,如果没有传该参数,就使用默认值。


@PathVariable

@PathVariable是带占位符的URL,Spring3.0新增的功能,该功能在SpringMVC向REST目标挺进发展过程中具有里程碑的意义。


@PathVariable:路径变量注解,其参数与大括号里的名字一样要保持一致,实例代码如下:


RequestMapping("yoodb/detail/{id}") public String getByMacAddress(@PathVariable String id){ //do something; }


通过@PathVariable可以将URL中占位符参数绑定到控制器处理方法的入参中:URL 中的{xxx}占位符可以通过@PathVariable("xxx") 绑定到操作方法的入参中。


其他注解

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


@Component:泛指组件,当组件不好归类时,可以使用这个注解进行标注。一般公共的方法会用上这个注解。


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


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


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


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


@Autowired @Qualifier(value = "demoInfoService") private DemoInfoService demoInfoService;


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


Spring Boot常用注解的含义及如何使用就简单介绍到这里,后期会针对每个注解深入讲解其含义和用法,欢迎大家持续关注微信公众号“Java精选”,下面大家可以写代码试一试吧。


推荐阅读

Spring Boot从入门到精通(二)配置GitHub并上传Maven项目

Spring Boot从入门到精通(一)搭建第一个Spring Boot程序

IntelliJ IDEA使用技巧——IDEA常用快捷键01期

IntelliJ IDEA使用技巧——IDEA增加jar包02期

IntelliJ IDEA使用技巧——IDEA工具Debug模式断点调试详解03期

IntelliJ IDEA使用技巧—IDEA设置默认Maven版本04期

IntelliJ IDEA使用技巧—使用EasyCode插件一键生成代码05期

Java面试技巧—面试者简历如何通过初步筛选

浅谈Java后端开发工程师腾讯面试经历分享总结

程序员未来的出路究竟在哪里?一位老码农的心声


更多推荐↓↓↓
 

关注下方微信公众号“Java精选”(w_z90110),回复关键词领取资料:如Mysql,Hadoop,Dubbo,Spring Boot等,免费领取视频教程、资料文档和项目源码。


Java精选专注程序员推送一些Java开发知识,包括基础知识、各大流行框架、大数据技术、数据库、算法与数据结构、面试专题、面试技巧经验、职业规划以及优质开源项目等。其中一部分由小编总结整理,另一部分来源于网络上优质资源,希望对大家的学习和工作有所帮助。

我就知道你“在看”!

您可能也对以下帖子感兴趣

文章有问题?点此查看未经处理的缓存