springboot 的常用注解使用总结解析

最新推荐文章于 2023-03-05 14:40:37 发布

西风包

最新推荐文章于 2023-03-05 14:40:37 发布

阅读量330

点赞数

分类专栏： java 文章标签： java

本文链接：https://blog.csdn.net/ssdfsfdf/article/details/104974470

版权

java 专栏收录该内容

3 篇文章 0 订阅

订阅专栏

1、@Controller

@Controller 用于标记在一个类上，使用它标记的类就是一个SpringMVC Controller 对象。

2.@RequestMapping

RequestMapping是一个用来处理请求地址映射的注解，可用于类或方法上。用于类上，表示类中的所有响应请求的方法都是以该地址作为父路径。

RequestMapping注解有六个属性，下面我们把她分成三类进行说明（下面有相应示例）。

1)、 value， method；

value：指定请求的实际地址，指定的地址可以是URI Template 模式（后面将会说明）；

method：指定请求的method类型， GET、POST、PUT、DELETE等；

2)、consumes，produces

consumes：指定处理请求的提交内容类型（Content-Type），例如application/json, text/html;

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

3)、params，headers

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

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

3.@PostMapping @GetMapping @RequestMapping

@GetMapping是一个组合注解，是@RequestMapping(method = RequestMethod.GET)的缩写。
@PostMapping是一个组合注解，是@RequestMapping(method = RequestMethod.POST)的缩写。
@PostMapping是一个非组合注解，需要自定义请求方式。

4.@RestController和@Controller

RestController相当于Controller+ResponseBody注解

5.@Resource和@Autowired

@Resource和@Autowired都是做bean的注入时使用，其实@Resource并不是Spring的注解，它的包是javax.annotation.Resource，需要导入，但是Spring支持该注解的注入。

1)、共同点

两者都可以写在字段和setter方法上。两者如果都写在字段上，那么就不需要再写setter方法。

2)、不同点

（1）@Autowired

@Autowired为Spring提供的注解，需要导入包org.springframework.beans.factory.annotation.Autowired;只按照byType注入。

public class TestServiceImpl {
    // 下面两种@Autowired只要使用一种即可
    @Autowired
    private UserDao userDao; // 用于字段上
    
    @Autowired
    public void setUserDao(UserDao userDao) { // 用于属性的方法上
        this.userDao = userDao;
    }
}

@Autowired注解是按照类型（byType）装配依赖对象，默认情况下它要求依赖对象必须存在，如果允许null值，可以设置它的required属性为false。如果我们想使用按照名称（byName）来装配，可以结合@Qualifier注解一起使用。如下：

public class TestServiceImpl {
    @Autowired
    @Qualifier("userDao")
    private UserDao userDao; 
}

（2）@Resource

@Resource默认按照ByName自动注入，由J2EE提供，需要导入包javax.annotation.Resource。@Resource有两个重要的属性：name和type，而Spring将@Resource注解的name属性解析为bean的名字，而type属性则解析为bean的类型。所以，如果使用name属性，则使用byName的自动注入策略，而使用type属性时则使用byType自动注入策略。如果既不制定name也不制定type属性，这时将通过反射机制使用byName自动注入策略。

public class TestServiceImpl {
    // 下面两种@Resource只要使用一种即可
    @Resource(name="userDao")
    private UserDao userDao; // 用于字段上
    
    @Resource(name="userDao")
    public void setUserDao(UserDao userDao) { // 用于属性的setter方法上
        this.userDao = userDao;
    }
}

注：最好是将@Resource放在setter方法上，因为这样更符合面向对象的思想，通过set、get去操作属性，而不是直接去操作属性。

@Resource装配顺序：

①如果同时指定了name和type，则从Spring上下文中找到唯一匹配的bean进行装配，找不到则抛出异常。

②如果指定了name，则从上下文中查找名称（id）匹配的bean进行装配，找不到则抛出异常。

③如果指定了type，则从上下文中找到类似匹配的唯一bean进行装配，找不到或是找到多个，都会抛出异常。

④如果既没有指定name，又没有指定type，则自动按照byName方式进行装配；如果没有匹配，则回退为一个原始类型进行匹配，如果匹配则自动装配。

@Resource的作用相当于@Autowired，只不过@Autowired按照byType自动注入。

6.@PathVariable ：

spring通过@PathVariable注解来获得请求url中的动态参数的，并且支持动态url访问，可以从url中直接提取参数而不需要采用?q=q&d=d的形式

同时变量url中的PathVariable还支持正则表达式校验，上面最后一个方法只能字母加后缀三个数字的方式访问

@RestController
@RequestMapping("/dynamic")
public class DynamicUrlController {
    //localhost:8080/dynamic/id/123:hello
    @RequestMapping("/id/{id}")
    public String id(
            @PathVariable("id") String id ) {
        return id;
    }
    //localhost:8080/dynamic/number/123:hello
    @RequestMapping("/number/{number}:hello")
    public int number(
            @PathVariable("number") int number ) {
        return number;
    }
    //localhost:8080/dynamic/number/123:hello/t
    @RequestMapping("/number/{number}:hello/t")
    public int anInt(
            @PathVariable("number") int number ) {
        return number;
    }
    //localhost:8080/dynamic/number/qwerwww333/t
    @RequestMapping("/number/{number:[a-z-]+}{other:\\d{3}}/t")
    public String regular(
            @PathVariable("number") String number ,
            @PathVariable("other")String other) {
        return number+other;
    }
    //不支持
/*    @RequestMapping("/date/{date}")
    public Date date(
            @PathVariable("date") Date date ) {
        return date;
    }*/
}

7.@RequestParam 注解的使用

在SpringMvc后台进行获取数据，一般是两种。
1.request.getParameter(“参数名”)
2.用@RequestParam注解获取

@RequestMapping("/")

public String Demo1(@RequestParam String lid){

System.out.println("----"+lid);

return null;

}

前台页面

<input type="text" name="lid" /> 

Console输出界面

----10

参数名字不一致

@RequestMapping("/")

public String Demo1(@RequestParam(name="lid") String id){

System.out.println("----"+id);

return null;

}

前台页面

<input type="text" name="lid" /> 

Console输出界面

----10

@RequestParam，@PathVariable等注解区别

http://localhost:8080/springmvc/hello/101?param1=10&param2=20
1
上面的一个url你可以这样写：

@RequestMapping("/hello/{id}")
public String getDetails(@PathVariable(value="id") String id,
@RequestParam(value="param1", required=true) String param1,
@RequestParam(value="param2", required=false) String param2){
.......
}

8.@SessionAttributes, @ModelAttribute

代表的是：该Controller的所有方法在调用前，先执行此@ModelAttribute方法，可用于注解和方法参数中，可以把这个@ModelAttribute特性，应用在BaseController当中，所有的Controller继承BaseController，即可实现在调用Controller时，先执行@ModelAttribute方法。

@SessionAttributes用于在会话中存储Model的属性，一般作用在类的级别。像下面的代码，model的属性user会被存储到session中，因为@ModelAttribute与@SessionAttributes有相同的注解。

@Controller
@SessionAttributes("user")
public class ModelController {

    @ModelAttribute("user")
    public User initUser(){
        User user = new User();
        user.setName("default");
        return user;
    }

}

@SessionAttribute是用于获取已经存储的session数据，并且作用在方法的层面上。

@RequestMapping("/session")
    public String session(
            @SessionAttribute("user") User user
    ){
        // do something
        return "index";
    }

9.@ResponseBody

作用：该注解用于将Controller的方法返回的对象，通过适当的HttpMessageConverter转换为指定格式后，写入到Response对象的body数据区。

使用时机：返回的数据不是html标签的页面，而是其他某种格式的数据时（如json、xml等）使用；

10.@Component

1、@Service用于标注业务层组件
2、@Controller用于标注控制层组件(如struts中的action)
3、@Repository用于标注数据访问组件，即DAO组件.
4、@Component泛指组件，当组件不好归类的时候，我们可以使用这个注解进行标注。

11.@Value：

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

@Value("#{}") 表示SpEl表达式通常用来获取bean的属性，或者调用bean的某个方法。当然还有可以表示常量

@Value("${}")

@Value("${}") 可以获取对应属性文件中定义的属性值。
假如我有一个application.properties文件里面配置了：

12.@Api @ApiOperation @ApiParam

@Api @ApiOperation @ApiParam主要是用于swagger提供开发者文档，文档中生成的注释内容

西风包

关注

0
点赞
踩
1

收藏

觉得还不错? 一键收藏
0
评论
springboot 的常用注解使用总结解析

1、@Controller@Controller用于标记在一个类上，使用它标记的类就是一个SpringMVC Controller对象。2.@RequestMappingRequestMapping是一个用来处理请求地址映射的注解，可用于类或方法上。用于类上，表示类中的所有响应请求的方法都是以该地址作为父路径。RequestMapping注解有六个属性，下面我们把她分成三类进行...
复制链接

扫一扫