SpringMVC框架中的常用注解

已于 2024-01-03 00:47:25 修改
阅读量1.2k 收藏 24
点赞数 24
分类专栏： springmvc 文章标签： spring
于 2024-01-03 00:28:50 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_54546701/article/details/135352439
版权

目录标题


Spring MVC 框架中的常用注解主要包括在控制器层（Controller）、服务层（Service）、数据访问层（Repository）、实体类（Entity）、请求参数（Request Parameters）等方面。以下是这些注解的主要含义和用例

@Autowired、@ComponentScan、@Configuration 和 @Bean 是 Spring 框架中常用的注解，用于实现依赖注入和配置管理。

一、在控制器层（Controller）使用的注解：

1、@Controller：

  • 含义： 标识一个类为 Spring MVC 控制器。

用例：


@Controller
public class MyController {
    // Controller methods
}

2、@RequestMapping：

  • 含义： 映射 HTTP 请求的 URL 到一个具体的处理方法。

用例：


@Controller
@RequestMapping("/example")
public class MyController {
    @RequestMapping("/hello")
    public String hello() {
        return "hello";
    }
}

3、@RequestParam：

  • 含义： 用于提取请求中的参数值。
  • 客户端发送请求 /example/greet?name=John

用例：


@Controller
@RequestMapping("/example")
public class MyController {
    @RequestMapping("/greet")
    public String greet(@RequestParam("name") String name) {
        return "Hello, " + name + "!";
    }
}

4、@PathVariable：

  • 含义： 用于将 URI 模板变量映射到处理方法的参数。
  • 客户端发送请求 /example/user/123

用例：

@Controller
@RequestMapping("/example")
public class MyController {
    @RequestMapping("/user/{id}")
    public String getUserById(@PathVariable("id") Long userId) {
        // Retrieve user with the specified ID
        return "userDetails";
    }
}

5、@PatchMapping：

  • 含义：用于映射PATCH请求到控制器方法。@PatchMapping是一个用于映射HTTP PATCH请求到控制器方法的注解，在SpringMVC中也可以使用。它可以用于方法级别，用于指定处理PATCH请求的方法。

用例：


@Controller
@RequestMapping("/users")
public class UserController {

    @PatchMapping("/{id}")
    public String updateUser(@PathVariable Long id, @RequestBody User user) {
        // ...
    }
}

二、CURD

1、@GetMapping: (查询)

  • 含义：处理 HTTP GET 请求。

用例：


@Controller
@RequestMapping("/users")
public class UserController {

    @GetMapping("/{id}")
    public String getUser(@PathVariable Long id) {
        // ...
    }
}

}

2、@PostMapping: (新增)

  • 含义：处理 HTTP POST 请求。

用例：

@Controller
@RequestMapping("/users")
public class UserController {

    @PostMapping
    public String createUser(@ModelAttribute User user) {
        // ...
    }
}

3、@PutMapping:(更新)

  • 含义：处理 HTTP PUT 请求。

用例：

@Controller
@RequestMapping("/users")
public class UserController {

    @PutMapping("/{id}")
    public String updateUser(@PathVariable Long id, @ModelAttribute User user) {
        // ...
    }
}

4、@DeleteMapping:(删除)

  • 含义：处理 HTTP DELETE 请求。

用例：

@Controller
@RequestMapping("/users")
public class UserController {

    @DeleteMapping("/{id}")
    public String deleteUser(@PathVariable Long id) {
        // ...
    }
}

5、@PatchMapping:

  • 含义：处理 HTTP PATCH 请求。

用例：

@Controller
@RequestMapping("/users")
public class UserController {

    @PatchMapping("/{id}")
    public String updateUser(@PathVariable Long id, @RequestBody User user) {
        // ...
    }
}

三、在服务层（Service）使用的注解：

1、@Service：

  • 含义： 标识一个类为服务层的组件。

用例：

@Service
public class MyService {
    // Service methods
}

@Service 是 Spring Framework 中的一个注解，用于标识一个类为服务层（Service Layer）的组件。服务层通常包含应用程序的业务逻辑，负责处理业务规则、调用数据访问层（Repository 或 DAO）执行数据库操作，并协调应用程序的不同部分

  1. 组件扫描： @Service 是 Spring 的组件扫描机制的一部分，标识带有该注解的类为一个服务层组件。在应用程序启动时，Spring 会扫描包路径下的所有组件，并注册为 Spring 容器中的 Bean。

  2. 依赖注入： 通过将 @Service 注解添加到类上，Spring IoC 容器会自动将该类的实例注入到其他需要依赖的组件中，例如控制器（Controller）或其他服务层组件。

  3. 事务管理： 在服务层执行的方法通常涉及数据库操作，@Service 注解通常与 @Transactional 注解一起使用，以启用事务管理。这确保了在业务方法中的一系列操作要么全部成功，要么全部失败（回滚）。

用例：

@Service
public class MyService {
    @Autowired
    private MyRepository myRepository;

    public String performBusinessLogic() {
        // Business logic implementation
        return "Business logic executed successfully";
    }

    public List<MyEntity> getAllEntities() {
        return myRepository.findAll();
    }
}

四、在数据访问层（Repository）使用的注解：

1、@Repository：

  • 含义： 标识一个类为数据访问层的组件，通常与 Spring 的数据访问异常转换一起使用。

用例：

@Repository
public class MyRepository {
    // Repository methods
}

五、在实体类（Entity）使用的注解：

1、@Entity：

  • 含义： 标识一个类为 JPA 实体类。

用例：

@Entity
public class User {
    // Entity properties and methods
}

@Entity 注解是 Java Persistence API (JPA) 的一部分，用于标识一个类为 JPA 实体类。JPA 是一种规范，用于描述如何通过 Java 对象与关系型数据库进行映射。@Entity 注解告诉 JPA，被注解的类将映射到数据库中的一个表。

  1. 数据库映射： @Entity 注解告诉 JPA 这个类与数据库中的表存在映射关系。类中的字段（成员变量）通常与表中的列相对应。

  2. 主键标识： 实体类通常需要一个主键，用于唯一标识每个实体对象。通过 @Entity 注解，JPA 可以识别实体类中的主键。

  3. 实体类识别： 当应用程序使用 JPA 进行持久化操作时，JPA 需要知道哪些类是实体类。@Entity 注解是 JPA 识别实体类的标志。

  4. 持久性操作： 通过实体类，可以执行 CRUD（Create, Read, Update, Delete）操作。JPA 提供了 EntityManager 接口，可以用于执行这些操作。

  5. 关系映射： 实体类之间的关系可以通过 JPA 进行映射，包括一对一、一对多、多对一、多对多等关系。

示例：

@Entity
public class User {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    @Column(name = "username")
    private String username;

    @Column(name = "email")
    private String email;

    // Getters and setters
}

六、请求参数相关注解：

1、@RequestBody：

  • 含义： 用于将 HTTP 请求的正文映射到方法参数。

用例：

@Controller
@RequestMapping("/example")
public class MyController {
    @RequestMapping("/processJson")
    public String processJson(@RequestBody MyJsonModel jsonModel) {
        // Process JSON data
        return "result";
    }
}

2、@ResponseBody：

  • 含义： 表示方法的返回值直接作为响应体，而不是视图名称。

用例：

@Controller
@RequestMapping("/example")
public class MyController {
    @RequestMapping("/getJson")
    @ResponseBody
    public MyJsonModel getJson() {
        // Return JSON data directly
    }
}

七、@Autowired：

  • 含义： 用于自动装配，将指定类型的 Bean 注入到属性、构造函数或方法参数中。

用例：

@Service
public class MyService {
    private final MyRepository repository;

    @Autowired
    public MyService(MyRepository repository) {
        this.repository = repository;
    }
}

在上例中，MyService 类通过 @Autowired 注解将 MyRepository 类型的 Bean 自动注入到构造函数中。

、八@ComponentScan：

  • 含义： 扫描指定包路径，寻找标有 @Component、@Service、@Repository、@Controller 注解的类，并将其注册为 Spring Bean。

用例：

@Configuration
@ComponentScan(basePackages = "com.example")
public class AppConfig {
    // Configuration content
}

在上例中，@ComponentScan 注解扫描 com.example 包路径下的所有类，将带有相应注解的类注册为 Spring Bean。

九、@Configuration：

  • 含义： 声明当前类是一个配置类，通常与 @Bean 注解一起使用，用于配置 Spring 应用上下文。

用例：

@Configuration
public class AppConfig {
    // Bean declarations using @Bean
}

在上例中，AppConfig 被声明为配置类，用于定义 Spring Bean。

十、@Bean：

  • 含义： 在配置类中使用，用于声明一个 Bean。

用例：

@Configuration
public class AppConfig {
    @Bean
    public MyService myService() {
        return new MyService(myRepository());
    }

    @Bean
    public MyRepository myRepository() {
        return new MyRepository();
    }
}

在上例中，@Bean 注解用于声明两个 Bean：MyService 和 MyRepository。

程序员小王꧔ꦿ
关注
  • 24
    点赞
  • 踩
  • 24
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
springmvc基础.docx
01-18
springmvc基础 包含代码+知识点+详细解释 1. 什么是springmvc？ 2. springmvc框架原理 前端控制器、处理器映射器、处理器适配器、视图解析器 3. springmvc入门程序 目的：对前端控制器、处理器映射器、处理器适配器、视图解析器学习 非注解的处理器映射器、处理器适配器 注解的处理器映射器、处理器适配器 4. springmvc和mybatis整合 5. springmvc注解开发 常用的注解学习 参数绑定（简单类型、pojo、集合类型） 自定义参数绑定 6. springmvc和struts2区别
ssh框架整合step by step (springMVC + spring 5.0.4 + hibernate 5.0.12)
06-03
ssh框架搭建step by step (springMVC + spring 5.0.4 + hibernate 5.0.12) 好久不弄web了, 周末心血来潮, 使用较新spirng/hibernate搭建一个ssh框架, 供有需要的同学参考/学习/使用. 使用eclipse开发, 搭建,分三步: ①(在一个dynamic web工程上)整合springMVC; ② 整合spring; ③ 整合hibernate # 使用entity/dao/service全部使用注解扫描, 大大减少再开发的代码量; # 事务的织入: 开发时不必再处理SessionFactory、Session等, 只要按配置文件指定的格式对方法进行命名, 即可自动开启/提交事务; # 做了BaseDao的简单封装, 并做了基于BaseDao的增/删/改/查/分页查询等操作的示例(并在示例中列出了访问路径); # 工程所需jar包、sql脚本放在了百度网盘(资源内有下载地址), jar包下载后拷贝到\WebContent\WEB-INF\lib路径下即可,; # git仓库记录也一并打包进, 有兴趣的同学可以查看项目是如何一步一步搭建起来的; # 不熟悉git的同学也没关系, 根据不同搭建进度, 资源内分别打了三个项目(springmvc、springmvc+spring、springmvc+spring+hibernate), 可逐个对比查看; # 项目主要描述ssh的搭建步骤, 前端仅仅是几个简单的展示页面; 如有疑问请留言, 欢迎指教交流!
整合SpringMVC、Spring、Mybatis开发信息管理系统
08-16
SpringMVC、Spring和MyBatis是Java开发中常用的框架，它们可以一起使用来开发信息管理系统。 首先，SpringMVC是一个基于MVC（Model-View-Controller）设计模式的轻量级Web框架，它可以处理Web请求和响应。它提供了一种简单而灵活的方式来构建Web应用程序。使用SpringMVC，你可以定义处理器方法（Controller），并使用注解将这些方法映射到特定的URL路径。此外，SpringMVC还提供了与视图解析器一起使用的功能，用于将模型数据渲染为最终的响应。 Spring框架是一个全功能的应用程序开发框架，它提供了许多功能和组件，以简化Java开发。Spring框架主要解决了企业级应用程序开发中的各种问题，如依赖注入（Dependency Injection）、面向切面编程（Aspect-Oriented Programming）和事务管理等。通过使用Spring框架，你可以更加轻松地编写可测试、可扩展和可维护的代码。在信息管理系统中，你可以使用Spring框架来管理各个层之间的依赖关系，并提供一种声明式的事务管理机制。 MyBa
SpringMVC（一）基础入门看这篇
12-22
文章目录一、SpringMVC的基本概念1.1 关于三层架构和MVC1.2 SpringMVC概述1.2.1 SpringMVC是什么1.2.2 SpringMVC在三层架构的位置1.2.3 SpringMVC的优势1.2.4 SpringMVC 和 Struts2 的优略分析二、SpringMVC入门案例2.1 入门案例2.2 案例分析2.3 五大核心组件2.4 RequestMapping注解2.5 Controller注解三、请求参数的绑定3.1 绑定说明3.2 支持的数据类型3.3 使用要求3.4 请求参数乱码问题3.5 自定义类型转换器四、常用注解4.1 RequestParam4
JAVA框架：Spring框架、SpringMVC框架、MyBytes框架、SpringBoot框架.zip
最新发布
04-24
springboot框架 一、Spring Boot基础应用 Spring Boot特征 概念： 约定优于配置，简单来说就是你所期待的配置与约定的配置一致，那么就可以不做任何配置，约定不符合期待时才需要对约定进行替换配置。 特征： 1. SpringBoot Starter：他将常用的依赖分组进行了整合，将其合并到一个依赖中，这样就可以一次性添加到项目的Maven或Gradle构建中。 2,使编码变得简单，SpringBoot采用 JavaConfig的方式对Spring进行配置，并且提供了大量的注解，极大的提高了工作效率，比如@Configuration和@bean注解结合，基于@Configuration完成类扫描，基于@bean注解把返回值注入IOC容器。 3.自动配置：SpringBoot的自动配置特性利用了Spring对条件化配置的支持，合理地推测应用所需的bean并自动化配置他们。 4.使部署变得简单，SpringBoot内置了三种Servlet容器，Tomcat，Jetty,undertow.我们只需要一个Java的运行环境就可以跑SpringBoot的项目了
SpringMVC的常用注解
淡墨青衫、剑轻吟
10-26 9498
SpringMVC的常用注解
SpringMVC常用注解
hd_cash的博客
03-20 7487
1：@RequestMapping 作用： @RequestMapping注解的作用就是将请求 和 处理请求的 控制器方法 关联起来，建立映射关系。 SpringMVC 接收到指定的请求，就会来找到在映射关系中对应的控制器方法来处理这个请求。 位置： @RequestMapping标识一个类：设置映射请求的请求路径的初始信息。 @RequestMapping标识一个方法：设置映射请求请求路径的具体信息。 属性： value： @RequestMapping注解的value属性通过请求的请求地址匹配
springMVC常用注解
热门推荐
qq_43549199的博客
10-20 1万+
在java框架中，使用注解的作用就是注入属性 一、Spring常用注解 @Component：标注一个普通的Spring Bean类。 @Controller：标注一个控制器组件类。 @Service：标注一个业务层组件类。 @Repository：标注一个dao持久层组件类。 Bean实例的名字默认是Bean类的首字母小写，其他部分不变。 尽量考虑使用@Controller，@Service，@Repository代替通用的@Component。 二、SpringMVC常用注解 @Controll
Spring MVC常用注解
dingd1234的博客
12-14 9121
一、Spring MVC 常用注解 1、@RequestMapping Spring MVC 通过 @RequestMapping 注解将 URL 请求与业务方法进行映射，在控制器的类定义处以及方法定义处都可以添加 @RequestMapping，在类定义处添加相当于多了一层访问路径。 @Controller @RequestMapping("/hello") public class HelloHandler { @RequestMapping("/index") public Stri
SpringMVC九大常用注解
11-03
SpringMVC九大常用注解 SpringMVC
springmvc常用注解标签详解
08-13
springmvc常用注解标签详解，总结，常用注解，标签详解，springmvc
Spring MVC常用的注解类
aochou19810706的博客
04-22 709
一、注解类配置 要使用springmvc的注解类，需要在springmvc.xml配置文件中用context:component-scan/扫描:  二、五大重要的注解类 1.RequestMapping注解 RequestMapping注解类的使用方法 在Controller控制器类的类定义和方法定义处都可以标注@RequestMapping注解 DispatcherS...
springmvc常用注解
weixin_43919497的博客
03-10 3050
1. RequestParam注解 作用：把请求中的指定名称的参数传递给控制器中的形参赋值 属性 value：请求参数中的名称 required：请求参数中是否必须提供此参数，默认值是true，必须提供 @RequestMapping("/param") public String testRequestParam(@RequestParam(value = "name",required = false) String username){ System.out.printl
SpringMVC常用注解，超全超详细
__Forward
12-18 1185
文章目录1、@Controller2、@RequestMapping3、@RequestParam4、@PathVariable5、@MatrixVariable6、@CrossOrigin7、@RequestHeader8、@CookieValue9、@RequestAttribute10、@SessionAttribute11、@SessionAttributes12、@ModelAttrib...
SpringMVC常用注解解释
kaszxc的博客
05-20 2376
1.ResquestParam ​ 作用：把请求中指定名称的参数给控制器中的形参赋值 ​ 属性： ​ value：请求参数中的名称 ​ required：请求参数中是否必须提供此参数。默认值true。表示必须提供，如果不提供讲报错 ​ 当所传的参数名字不同是可以使用这可注解，但是一旦使用所传参数必须有RequestParam内相同名称的参 数否则报错 [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-XiZvU5a6-1589979251501)(
SpringMVC框架中的常用注解（全是干货，干的要死！）
qq_46138492的博客
03-12 2134
SpringMVC框架中的常用注解（全是干货，干的要死！）
springmvc的常用注解
weixin_58476531的博客
02-25 2144
1.@RequestParam 1.作用在方法传递的参数前，用于接收所传参数(是springmvc中接受普通参数的注解) 2.属性 ：value 请求参数中的名称 required：请求参数中是否提供此参数，默认为true defaultValue：指定参数的默认值 @RequestMapping("/user") @Controller public class QuickContr...
springmvc框架中常用的注解？
06-08
SpringMVC 框架中常用的注解有以下几种： 1. @Controller：标注一个类是 SpringMVC 控制器。 2. @RequestMapping：用于建立请求 URL 和处理请求方法之间的对应关系。可以用在类和方法上。 3. @PathVariable：用于将 URL 中的占位符参数绑定到方法的参数中。 4. @RequestParam：用于将请求参数绑定到方法的参数中。 5. @ResponseBody：用于将 Controller 的方法返回的对象，通过适当的转换器转换为指定的格式后，写入到 HTTP 响应中。 6. @RequestBody：用于将 HTTP 请求正文转换为适合的 Java 类型的对象。 7. @ModelAttribute：用于将请求参数绑定到模型对象中，并将其暴露给视图。 8. @SessionAttributes：用于指定模型对象中的哪些属性需要被存储到 session 中。 9. @InitBinder：用于设置 WebDataBinder，用于自动绑定前台请求参数到 Model 中。 这些注解能够帮助我们更加方便地处理请求和响应，提高代码的可读性和可维护性。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

程序员小王꧔ꦿ

感谢打赏

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值