乐趣区

关于java:常用的这5类SpringBoot注解竟然还有人不知道

一、注解 (annotations) 列表

1、@SpringBootApplication

蕴含了 @ComponentScan、@Configuration 和 @EnableAutoConfiguration 注解。其中 @ComponentScan 让 Spring Boot 扫描到 Configuration 类并把它退出到程序上下文。

2、@ComponentScan

组件扫描,可主动发现和拆卸一些 Bean。

3、@Configuration

等同于 Spring 的 XML 配置文件;应用 Java 代码能够查看类型平安。

4、@EnableAutoConfiguration

主动配置

5、@RestController

该注解是 @Controller 和 @ResponseBody 的合集, 示意这是个控制器 Bean, 并且是将函数的返回值间接填入 HTTP 响应体中, 是 REST 格调的控制器。

6、@Autowired

主动导入。

7、@PathVariable

获取参数。

8、@JsonBackReference

解决嵌套外链问题。

9、@RepositoryRestResourcepublic

配合 spring-boot-starter-data-rest 应用。

二、注解 (annotations) 详解

1、@SpringBootApplication

申明让 Spring Boot 主动给程序进行必要的配置,这个配置等同于:@Configuration,@EnableAutoConfiguration 和 @ComponentScan 三个配置。
《2020 最新 Java 根底精讲视频教程和学习路线!》

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication // same as @Configuration @EnableAutoConfiguration @ComponentScan
public class Application {public static void main(String[] args) {SpringApplication.run(Application.class, args);
    }
}
复制代码

2、@ResponseBody

示意该办法的返回后果间接写入 HTTP Response Body 中,个别在异步获取数据时应用,用于构建 RESTful 的 api。

在应用 @RequestMapping 后,返回值通常解析为跳转门路,加上 @ResponseBody 后返回后果不会被解析为跳转门路,而是间接写入 HTTP Response Body 中。

比方异步获取 json 数据,加上 @ResponseBody 后,会间接返回 json 数据。

该注解个别会配合 @RequestMapping 一起应用。

示例代码:

@RequestMapping(“/test”)
@ResponseBody
public String test(){return”ok”;}
复制代码

3、@Controller

用于定义控制器类,在 spring 我的项目中由控制器负责将用户发来的 URL 申请转发到对应的服务接口(service 层)

个别这个注解在类中,通常办法须要配合注解 @RequestMapping。

示例代码:

@Controller
@RequestMapping(“/demoInfo”)
publicclass DemoController {
    @Autowired
    private DemoInfoService demoInfoService;

    @RequestMapping("/hello")
    public String hello(Map map){System.out.println("DemoController.hello()");
        map.put("hello","from TemplateController.helloHtml");
        // 会应用 hello.html 或者 hello.ftl 模板进行渲染显示.
        return"/hello";
    }
}
复制代码

4、@RestController

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

示例代码:

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping(“/demoInfo2”)
publicclass DemoController2 {@RequestMapping("/test")
    public String test(){return"ok";}
}
复制代码

5、@RequestMapping

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

6、@EnableAutoConfiguration

Spring Boot 主动配置(auto-configuration):尝试依据你增加的 jar 依赖主动配置你的 Spring 利用。

例如,如果你的 classpath 下存在 HSQLDB,并且你没有手动配置任何数据库连贯 beans,那么咱们将主动配置一个内存型(in-memory)数据库”。

你能够将 @EnableAutoConfiguration 或者 @SpringBootApplication 注解增加到一个 @Configuration 类上来抉择主动配置。

如果发现利用了你不想要的特定主动配置类,你能够应用 @EnableAutoConfiguration 注解的排除属性来禁用它们。

搜寻 Java 知音公众号,回复“后端面试”,送你一份 Java 面试题宝典.pdf

7、@ComponentScan

示意将该类主动发现扫描组件。

集体了解相当于,如果扫描到有 @Component、@Controller、@Service 等这些注解的类,并注册为 Bean,能够主动收集所有的 Spring 组件,包含 @Configuration 类。

咱们常常应用 @ComponentScan 注解搜寻 beans,并联合 @Autowired 注解导入。能够主动收集所有的 Spring 组件,包含 @Configuration 类。

如果没有配置的话,Spring Boot 会扫描启动类所在包下以及子包下的应用了 @Service、@Repository 等注解的类。

8、@Configuration

相当于传统的 xml 配置文件,如果有些第三方库须要用到 xml 文件,倡议依然通过 @Configuration 类作为我的项目的配置主类——能够应用 @ImportResource 注解加载 xml 配置文件。

9、@Import

用来导入其余配置类。

10、@ImportResource

用来加载 xml 配置文件。

11、@Autowired

主动导入依赖的 bean

12、@Service

个别用于润饰 service 层的组件

13、@Repository

应用 @Repository 注解能够确保 DAO 或者 repositories 提供异样转译,这个注解润饰的 DAO 或者 repositories 类会被 ComponetScan 发现并配置,同时也不须要为它们提供 XML 配置项。

14、@Bean

用 @Bean 标注办法等价于 XML 中配置的 bean。

15、@Value

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

示例代码

@Value(value =“#{message}”)
private String message;
复制代码

16、@Inject

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

17、@Component

泛指组件,当组件不好归类的时候,咱们能够应用这个注解进行标注。

18、@Bean

相当于 XML 中的, 放在办法的下面,而不是类,意思是产生一个 bean, 并交给 spring 治理。

19、@AutoWired

主动导入依赖的 bean。byType 形式。把配置好的 Bean 拿来用,实现属性、办法的组装,它能够对类成员变量、办法及构造函数进行标注,实现主动拆卸的工作。当加上(required=false)时,就算找不到 bean 也不报错。

20、@Qualifier

当有多个同一类型的 Bean 时,能够用 @Qualifier(“name”)来指定。与 @Autowired 配合应用。@Qualifier 限定描述符除了能依据名字进行注入,但能进行更细粒度的管制如何抉择候选者,具体应用形式如下:

@Autowired
@Qualifier(value =“demoInfoService”)
private DemoInfoService demoInfoService;
复制代码

21、@Resource(name=”name”,type=”type”)

没有括号内内容的话,默认 byName。与 @Autowired 干相似的事。

搜寻 Java 知音公众号,回复“后端面试”,送你一份 Java 面试题宝典.pdf

三、JPA 注解

1、@Entity:@Table(name=”“)

表明这是一个实体类。个别用于 jpa 这两个注解个别一块应用,然而如果表名和实体类名雷同的话,@Table 能够省略。

2、@MappedSuperClass

用在确定是父类的 entity 上。父类的属性子类能够继承。

3、@NoRepositoryBean

个别用作父类的 repository,有这个注解,Spring 不会去实例化该 repository。

4、@Column

如果字段名与列名雷同,则能够省略。

5、@Id

示意该属性为主键。

6、@GeneratedValue(strategy=GenerationType.SEQUENCE,generator=“repair_seq”)

示意主键生成策略是 sequence(能够为 Auto、IDENTITY、native 等,Auto 示意可在多个数据库间切换),指定 sequence 的名字是 repair_seq。

7、@SequenceGeneretor(name =“repair_seq”, sequenceName =“seq_repair”, allocationSize = 1)

name 为 sequence 的名称,以便应用,sequenceName 为数据库的 sequence 名称,两个名称能够统一。

8、@Transient

示意该属性并非一个到数据库表的字段的映射,ORM 框架将疏忽该属性。

如果一个属性并非数据库表的字段映射, 就务必将其标示为 @Transient, 否则,ORM 框架默认其注解为 @Basic。

9、@Basic(fetch=FetchType.LAZY)

标记能够指定实体属性的加载形式。

10、@JsonIgnore

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

11、@JoinColumn(name=”loginId”)

一对一:本表中指向另一个表的外键。一对多:另一个表指向本表的外键。

12、@OneToOne、@OneToMany、@ManyToOne

对应 hibernate 配置文件中的一对一,一对多,多对一。

四、SpringMVC 相干注解

1、@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) 类型中蕴含该指定类型才返回。

2、@RequestParam

用在办法的参数后面。

3、@PathVariable

门路变量。如:

RequestMapping(“user/get/{macAddress}”)
public String getByMacAddress(@PathVariable String macAddress){//do something;}
复制代码

参数与大括号里的名字一样要雷同。

五、全局异样解决

@ControllerAdvice:蕴含 @Component。能够被扫描到。对立解决异样。

@ExceptionHandler(Exception.class):用在办法下面示意遇到这个异样就执行以下办法。

链接:https://juejin.cn/post/690710…

退出移动版