springboot 常用的注解标签的概念及用法RequiredArgsConstructor 、RestController、RequestMapping

简介: 【4月更文挑战第12天】在 Spring Boot 中,@RequiredArgsConstructor, @RestController, 和 @RequestMapping 是常用的注解,每个都有其特定的功能和用法,它们合起来极大地简化了 Spring 应用程序的开发过程。

@RequiredArgsConstructor 是 Lombok 库中的一个注解,用于自动化生成构造函数的代码。这个注解会为类中所有声明为 final 或者带有 @NonNull 注解的成员变量生成一个构造函数。这样做的目的是简化代码,减少模板化的构造函数代码,提高开发效率。

概念

@RequiredArgsConstructor 生成的是一个“必需的”构造函数,意味着该构造函数参数包含了所有那些必须要进行初始化的字段。对于以下类型的字段,构造函数将不会包括它们:

  • final 和非 @NonNull 的字段,因为这些字段可以在之后被设置。
  • 已经在声明时被初始化的 final 字段,因为它们已经有了初始值。

用法

在一个类上使用 @RequiredArgsConstructor 注解,Lombok 将自动为这个类生成一个构造函数,包含所有需要立即初始化的成员变量。这对于依赖注入或者确保数据不可变性特别有用。

示例代码:

java复制代码

import lombok.RequiredArgsConstructor;
import lombok.NonNull;

@RequiredArgsConstructor
public class ExampleClass {
    private final int id;
    private final String name;
    @NonNull private String description;

    // 其他方法...
}

在上述代码中,ExampleClass 会自动生成一个构造函数,如下:

java复制代码

public ExampleClass(int id, String name, String description) {
    this.id = id;
    this.name = name;
    if (description == null) throw new NullPointerException("description is marked non-null but is null");
    this.description = description;
}

这个构造函数包含了所有 final 字段和用 @NonNull 注明必须不为 null 的字段。如果 description 为 null,则构造函数会抛出 NullPointerException,这确保了必需字段在对象实例化时不会被遗漏。

使用 @RequiredArgsConstructor 可以使代码更加简洁并减少错误,特别是在处理不可变类或需要依赖注入的情况下非常有用。


@RestController 是 Spring Framework 中的一个注解,用于标记一个类为控制器,其中所有的方法都会默认返回值作为 HTTP 响应的主体。它是 @Controller@ResponseBody 注解的组合,这意味着你不需要在每个方法上单独使用 @ResponseBody@RestController 注解非常适用于创建 RESTful Web 服务。

概念

@RestController 注解的主要目的是简化 RESTful 控制器的开发。通过自动将方法的返回值转换为 JSON 或 XML 响应,这个注解让开发者能够专注于业务逻辑,而不是响应的细节处理。Spring 框架通过使用消息转换器来自动处理数据格式的转换。

用法

在一个类上使用 @RestController,意味着类中的所有公开方法都会处理 HTTP 请求,并且方法的返回值直接写入 HTTP 响应主体,通常是以 JSON 或 XML 格式返回。

示例代码:

java复制代码

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

@RestController
public class ExampleController {

    @RequestMapping("/greet")
    public String greet() {
        return "Hello, World!";
    }
}

在上述代码中,ExampleController 类通过 @RestController 注解被标记为一个控制器,greet 方法处理对 /greet 路径的请求。方法的返回值 "Hello, World!" 会自动转换为 HTTP 响应主体。

典型用途

@RestController 常用于构建 API,如下几个方面特别突出:

  1. 快速开发: 省去了多余的配置,直接标记类和方法即可。
  2. 清晰简洁: 方法直接返回对象或值,Spring 负责转换工作,代码更清晰。
  3. 易于集成测试: 由于控制器逻辑通常只依赖于输入和输出,使得编写集成测试变得更加直接。

使用 @RestController 可以显著简化 RESTful 服务的开发流程,提高开发效率,并保持代码的整洁和可维护性。


@RequestMapping 是 Spring Framework 中的一个注解,用于将 HTTP 请求映射到特定的处理方法上。它可以应用于类级别和方法级别。@RequestMapping 注解可以处理不同类型的请求方法,如 GET、POST、PUT、DELETE 等,并支持定制请求的 URL 模式、请求参数和请求头。

概念

@RequestMapping 注解的主要目的是将某个 HTTP 请求与处理该请求的方法关联起来。通过指定请求的路径、方法、参数等属性,可以实现对请求的精确控制。

用法

在类级别使用:

@RequestMapping 注用于类级别时,它指定了一个基础的请求路径。类中的所有方法都将继承这个路径。

java复制代码

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

@RestController
@RequestMapping("/api")
public class ExampleController {

    @RequestMapping("/greet")
    public String greet() {
        return "Hello from /api/greet";
    }
}

在上述代码中,ExampleController 类处理以 /api 开头的请求。greet 方法进一步处理以 /api/greet 为路径的请求。

在方法级别使用:

@RequestMapping 也可以用于方法级别,以处理特定的请求路径和方法。

java复制代码

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

@RestController
public class ExampleController {

    @RequestMapping(value = "/greet", method = RequestMethod.GET)
    public String greet() {
        return "Hello, World!";
    }
}

在这个例子中,greet 方法仅处理以 /greet 为路径的 GET 请求。

属性

@RequestMapping 注解提供了多个属性来定制请求映射:

  • valuepath: 指定请求的 URL 模式。
  • method: 指定请求的 HTTP 方法,如 GET、POST 等。
  • params: 指定请求必须包含的参数。
  • headers: 指定请求必须包含的请求头。
  • consumes: 指定请求的内容类型(Content-Type)。
  • produces: 指定响应的内容类型(Accept)。

通过使用这些属性,可以实现对请求的细粒度控制,满足不同场景下的需求。

相关文章
|
2天前
|
IDE Java Maven
Springboot中Processor注解概念以及实战案例
【5月更文挑战第28天】在Spring Boot中,没有直接名为Processor的注解。不过,你可能是在谈论与Spring Boot相关的注解处理器(Annotation Processors)的概念,尤其是在处理自定义注解或@ConfigurationProperties注解时的情况。
13 1
|
3天前
|
Java 开发者 Spring
Springboot中的@Bean用法以及常见问题
【5月更文挑战第27天】@Bean 注解是Spring框架中用于声明Spring应用上下文中的bean的一种方式。在Spring Boot中,@Bean注解通常与@Configuration注解一起使用,在配置类(Configuration class)中定义bean。
20 2
|
6天前
|
Java Spring 容器
Spring注解开发,bean的作用范围及生命周期、Spring注解开发依赖注入
Spring注解开发,bean的作用范围及生命周期、Spring注解开发依赖注入
16 1
Spring注解开发,bean的作用范围及生命周期、Spring注解开发依赖注入
|
6天前
|
缓存 NoSQL Java
Spring Cache之本地缓存注解@Cacheable,@CachePut,@CacheEvict使用
SpringCache不支持灵活的缓存时间和集群,适合数据量小的单机服务或对一致性要求不高的场景。`@EnableCaching`启用缓存。`@Cacheable`用于缓存方法返回值,`value`指定缓存名称,`key`定义缓存键,可按SpEL编写,`unless`决定是否不缓存空值。当在类上使用时,类内所有方法都支持缓存。`@CachePut`每次执行方法后都会更新缓存,而`@CacheEvict`用于清除缓存,支持按键清除或全部清除。Spring Cache结合Redis可支持集群环境。
49 5
|
7天前
|
Java Python Spring
小唐开始学 Spring Boot——(2)Spring Boot核心配置与注解
小唐开始学 Spring Boot——(2)Spring Boot核心配置与注解
|
14天前
|
Java
Springboot 使用自定义注解结合AOP方式校验接口参数
Springboot 使用自定义注解结合AOP方式校验接口参数
Springboot 使用自定义注解结合AOP方式校验接口参数
|
15天前
|
存储 缓存 Java
【JavaEE】Spring中注解的方式去获取Bean对象
【JavaEE】Spring中注解的方式去获取Bean对象
4 0
|
15天前
|
存储 Java 对象存储
【JavaEE】Spring中注解的方式去存储Bean对象
【JavaEE】Spring中注解的方式去存储Bean对象
11 0
|
15天前
|
JSON 前端开发 Java
【JAVA进阶篇教学】第七篇:Spring中常用注解
【JAVA进阶篇教学】第七篇:Spring中常用注解
|
15天前
|
JavaScript Java 开发者
Spring Boot中的@Lazy注解:概念及实战应用
【4月更文挑战第7天】在Spring Framework中,@Lazy注解是一个非常有用的特性,它允许开发者控制Spring容器的bean初始化时机。本文将详细介绍@Lazy注解的概念,并通过一个实际的例子展示如何在Spring Boot应用中使用它。
27 2