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)。

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

相关文章
|
3月前
|
XML Java 测试技术
Spring IOC—基于注解配置和管理Bean 万字详解(通俗易懂)
Spring 第三节 IOC——基于注解配置和管理Bean 万字详解!
271 26
|
4月前
|
缓存 Java 数据库
SpringBoot缓存注解使用
Spring Boot 提供了一套方便的缓存注解,用于简化缓存管理。通过 `@Cacheable`、`@CachePut`、`@CacheEvict` 和 `@Caching` 等注解,开发者可以轻松地实现方法级别的缓存操作,从而提升应用的性能和响应速度。合理使用这些注解可以大大减少数据库的访问频率,优化系统性能。
246 89
|
2月前
|
JSON 前端开发 Java
Spring MVC常用的注解
@RequestMapping:用于处理请求 url 映射的注解,可用于类或方法上。用于类上,则表示类中 的所有响应请求的方法都是以该地址作为父路径。 @RequestBody:注解实现接收http请求的json数据,将json转换为java对象。 @ResponseBody:注解实现将conreoller方法返回对象转化为json对象响应给客户。 @Controller:控制器的注解,表示是表现层,不能用用别的注解代替 @RestController : 组合注解 @Conntroller + @ResponseBody @GetMapping , @PostMapping , @Put
|
2月前
|
Java Spring
Spring Boot的核心注解是哪个?他由哪几个注解组成的?
Spring Boot的核心注解是@SpringBootApplication , 他由几个注解组成 : ● @SpringBootConfiguration: 组合了- @Configuration注解,实现配置文件的功能; ● @EnableAutoConfiguration:打开自动配置的功能,也可以关闭某个自动配置的选项 ● @ComponentScan:Spring组件扫描
|
2月前
|
Java 测试技术 Spring
SpringBoot+@Async注解一起用,速度提升
本文介绍了异步调用在高并发Web应用性能优化中的重要性,对比了同步与异步调用的区别。同步调用按顺序执行,每一步需等待上一步完成;而异步调用无需等待,可提升效率。通过Spring Boot示例,使用@Async注解实现异步任务,并借助Future对象处理异步回调,有效减少程序运行时间。
|
1月前
|
人工智能 缓存 自然语言处理
保姆级Spring AI 注解式开发教程,你肯定想不到还能这么玩!
这是一份详尽的 Spring AI 注解式开发教程,涵盖从环境配置到高级功能的全流程。Spring AI 是 Spring 框架中的一个模块,支持 NLP、CV 等 AI 任务。通过注解(如自定义 `@AiPrompt`)与 AOP 切面技术,简化了 AI 服务集成,实现业务逻辑与 AI 基础设施解耦。教程包含创建项目、配置文件、流式响应处理、缓存优化及多任务并行执行等内容,助你快速构建高效、可维护的 AI 应用。
|
5月前
|
Java Spring
【Spring】方法注解@Bean,配置类扫描路径
@Bean方法注解,如何在同一个类下面定义多个Bean对象,配置扫描路径
235 73
|
3月前
|
监控 Java Spring
SpringBoot:SpringBoot通过注解监测Controller接口
本文详细介绍了如何通过Spring Boot注解监测Controller接口,包括自定义注解、AOP切面的创建和使用以及具体的示例代码。通过这种方式,可以方便地在Controller方法执行前后添加日志记录、性能监控和异常处理逻辑,而无需修改方法本身的代码。这种方法不仅提高了代码的可维护性,还增强了系统的监控能力。希望本文能帮助您更好地理解和应用Spring Boot中的注解监测技术。
104 16
|
2月前
|
XML Java 数据库连接
微服务——SpringBoot使用归纳——Spring Boot集成MyBatis——基于注解的整合
本文介绍了Spring Boot集成MyBatis的两种方式:基于XML和注解的形式。重点讲解了注解方式,包括@Select、@Insert、@Update、@Delete等常用注解的使用方法,以及多参数时@Param注解的应用。同时,针对字段映射不一致的问题,提供了@Results和@ResultMap的解决方案。文章还提到实际项目中常结合XML与注解的优点,灵活使用两者以提高开发效率,并附带课程源码供下载学习。
56 0
|
5月前
|
Java Spring 容器
【SpringFramework】Spring IoC-基于注解的实现
本文主要记录基于Spring注解实现IoC容器和DI相关知识。
87 21