欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

SpringBoot常用注解梳理

程序员文章站 2022-10-03 17:08:24
SpringBoot常用注解梳理前言:最近在学习非常流行的j2ee框架springboot.框架方便的同时,我们也应该了解他的一些原理.尤其是注解,SpringBoot中使用了非常多的注解,使得代码量大大减少.常用注解列表:@SpringBootApplication: 包含了@ComponentScan、@Configuration和@EnableAutoConfiguration注解。其中@ComponentScan让spring Boot扫描到Configuration类并把它加入到程序上...

SpringBoot常用注解梳理

前言:

最近在学习非常流行的j2ee框架springboot.框架方便的同时,我们也应该了解他的一些原理.尤其是注解,SpringBoot中使用了非常多的注解,使得代码量大大减少.

常用注解列表:

  • @SpringBootApplication: 包含了@ComponentScan、@Configuration和@EnableAutoConfiguration注解。其中@ComponentScan让spring Boot扫描到Configuration类并把它加入到程序上下文。

  • @Configuration 等同于spring的XML配置文件;使用Java代码可以检查类型安全。

  • @EnableAutoConfiguration 自动配置。

  • @ComponentScan 组件扫描,可自动发现和装配一些Bean。

  • @Component 可配合CommandLineRunner使用,在程序启动后执行一些基础任务。

  • @RestController 注解是@Controller和@ResponseBody的合集,表示这是个控制器bean,并且是将函数的返回值直 接填入HTTP响应体中,是REST风格的控制器。

  • @Autowired 自动导入。

  • @PathVariable 获取参数。

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

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

注解详情

  • @SpringBootApplication:

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

这里以我在学习过程中的第一个HelloWorld项目为例

package com.hy;

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

@SpringBootApplication
// same as @Configuration @EnableAutoConfiguration @ComponentScan

public class HelloApplication {

    public static void main(String[] args) {
        SpringApplication.run(HelloApplication.class, args);
    }
}

  • @ResponseBody:

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

示例代码:

@RequestMapping(/test”)
@ResponseBody
public String test(){
    return”ok”;
}
  • @Controller:

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

@Controller
@RequestMapping(/demoInfo”)
public class DemoController {
    @Autowired
    private DemoInfoService demoInfoService;

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

重点重点重点

  • @RestController:

    用于标注控制层组件,是@ResponseBody和@Controller的合集。 在SpringBoot2以上的版本经常使用它替换以上两者

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";
    }
}
  • @RequestMapping:

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

  • @EnableAutoConfiguration:

    Spring Boot自动配置(auto-configuration):尝试根据你添加的jar依赖自动配置你的Spring应用。

    我们可以将@EnableAutoConfiguration或者@SpringBootApplication注解添加到一个@Configuration类上来选择自动配置。如果发现应用了我们不想要的特定自动配置类,我们可以使用@EnableAutoConfiguration注解的排除属性来禁用它们。

  • @ComponentScan:

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

    我们经常使用@ComponentScan注解搜索beans,并结合@Autowired注解导入。可以自动收集所有的Spring组件,包括@Configuration类。我们经常使用@ComponentScan注解搜索beans,并结合@Autowired注解导入。

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

  • @Configuration:

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

  • @Autowired:

    自动导入依赖的bean

  • @Repository:

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

  • @Value:

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

  • @RequestMapping:

    @RequestMapping(“/path”)表示该控制器处理所有“/path”的UR L请求。RequestMapping是一个用来处理请求地址映射的注解,可用于类或方法上。用于类上,表示类中的所有响应请求的方法都是以该地址作为父路径。该注解有六个属性:

    1. params:指定request中必须包含某些参数值是,才让该方法处理。
    2. headers:指定request中必须包含某些指定的header值,才能让该方法处理请求。
    3. value:指定请求的实际地址,指定的地址可以是URI Template 模式
    4. method:指定请求的method类型, GET、POST、PUT、DELETE等
    5. consumes:指定处理请求的提交内容类型(Content-Type),如application/json,text/html;
    6. produces:指定返回的内容类型,仅当request请求头中的(Accept)类型中包含该指定类型才返回

本文地址:https://blog.csdn.net/storm_55/article/details/107494439

相关标签: javaee java