大家好,我是架构君,一个会写代码吟诗的架构师。今天说一说springboot常用注解使用详解,希望能够帮助大家进步!!!
对于springboot而言,需要掌握平常使用的注解案例详解如下:
@Controller//标明这是一个SpringMVC的Controller控制器;
@SpringBootApplication//Spring Boot项目的核心注解,主要目的是开启自动配置。
@Configuration//这是一个配置Spring的配置类;
public class HelloApplication {
代码语言:txt复制 @RequestMapping("hello")//请求路径
代码语言:txt复制@ResponseBody//返回json数据
代码语言:txt复制public String hello() {
代码语言:txt复制 return "hello world! 你好世界!";
代码语言:txt复制}
代码语言:txt复制//在main方法中启动一个应用,即:这个应用的入口
代码语言:txt复制public static void main(String[] args) {
//springboot的启动入口
SpringApplication.run(HelloApplication.class, args);
代码语言:txt复制}
}
@Configuration // 加载外部配置
@PropertySource(value = { "classpath:jdbc.properties", "classpath:env.properties", "classpath:httpclient.properties" }) // 读取配置文件数据
@ComponentScan(basePackages = "com.demo") // 扫描包
@ImportResource(value = "classpath:dubbo/dubbo-consumer.xml")//导入dubbo资源
@SpringBootApplication Spring Boot项目的核心注解,主要目的是开启自动配置,Spring Boot来自动选择并且完成web的相关加载工作。
其他理解说明:当然每个人有自己的理解方法,具体可以根据自己的处理。
@SpringBootApplication:
包含@Configuration、@EnableAutoConfiguration、@ComponentScan
通常用在主类上。
@Repository:
用于标注数据访问组件,即DAO组件。
@Service:
用于标注业务层组件。
@RestController:
用于标注控制层组件(如struts中的action),包含@Controller和@ResponseBody。
@ResponseBody:
表示该方法的返回结果直接写入HTTP response body中
一般在异步获取数据时使用,在使用@RequestMapping后,返回值通常解析为跳转路径,加上@responsebody后返回结果不会被解析为跳转路径,而是直接写入HTTP response body中。比如异步获取json数据,加上@responsebody后,会直接返回json数据。
@Component:
泛指组件,当组件不好归类的时候,我们可以使用这个注解进行标注。
@ComponentScan:
组件扫描。个人理解相当于<context:component-scan>,如果扫描到有@Component @Controller @Service等这些注解的类,则把这些类注册为bean。
@Configuration:
指出该类是 Bean 配置的信息源,相当于XML中的<beans></beans>,一般加在主类上。
@Bean:
相当于XML中的<bean></bean>,放在方法的上面,而不是类,意思是产生一个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)类型中包含该指定类型才返回
@RequestParam:
用在方法的参数前面。
@RequestParam String a =request.getParameter("a")。
@PathVariable:
路径变量。参数与大括号里的名字一样要相同。
代码语言:javascript复制RequestMapping("user/get/mac/{macAddress}")
public String getByMacAddress(@PathVariable String macAddress){
//do something;
}
只听到从架构师办公室传来架构君的声音:
九月九日眺山川,归心归望积风烟。有谁来对上联或下联?
@Profiles
Spring Profiles提供了一种隔离应用程序配置的方式,并让这些配置只能在特定的环境下生效。
任何@Component或@Configuration都能被@Profile标记,从而限制加载它的时机。
代码语言:javascript复制@Configuration
@Profile("prod")
public class ProductionConfiguration {
// ...
}
@ConfigurationProperties
Spring Boot将尝试校验外部的配置,默认使用JSR-303(如果在classpath路径中)。
你可以轻松的为你的@ConfigurationProperties类添加JSR-303 javax.validation约束注解:
代码语言:javascript复制@Component
@ConfigurationProperties(prefix="connection")
public class ConnectionSettings {
@NotNull
private InetAddress remoteAddress;
// ... getters and setters
}
全局异常处理
@ControllerAdvice:
包含@Component。可以被扫描到。
统一处理异常。
@ExceptionHandler(Exception.class):
用在方法上面表示遇到这个异常就执行以下方法。