SpringMVC框架中的常用注解_springmvc常用注解-程序员宅基地

技术标签: spring  springmvc  


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。

版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。
本文链接:https://blog.csdn.net/weixin_54546701/article/details/135352439

智能推荐

稀疏编码的数学基础与理论分析-程序员宅基地

文章浏览阅读290次,点赞8次,收藏10次。1.背景介绍稀疏编码是一种用于处理稀疏数据的编码技术,其主要应用于信息传输、存储和处理等领域。稀疏数据是指数据中大部分元素为零或近似于零的数据,例如文本、图像、音频、视频等。稀疏编码的核心思想是将稀疏数据表示为非零元素和它们对应的位置信息,从而减少存储空间和计算复杂度。稀疏编码的研究起源于1990年代,随着大数据时代的到来,稀疏编码技术的应用范围和影响力不断扩大。目前,稀疏编码已经成为计算...

EasyGBS国标流媒体服务器GB28181国标方案安装使用文档-程序员宅基地

文章浏览阅读217次。EasyGBS - GB28181 国标方案安装使用文档下载安装包下载,正式使用需商业授权, 功能一致在线演示在线API架构图EasySIPCMSSIP 中心信令服务, 单节点, 自带一个 Redis Server, 随 EasySIPCMS 自启动, 不需要手动运行EasySIPSMSSIP 流媒体服务, 根..._easygbs-windows-2.6.0-23042316使用文档

【Web】记录巅峰极客2023 BabyURL题目复现——Jackson原生链_原生jackson 反序列化链子-程序员宅基地

文章浏览阅读1.2k次,点赞27次,收藏7次。2023巅峰极客 BabyURL之前AliyunCTF Bypassit I这题考查了这样一条链子:其实就是Jackson的原生反序列化利用今天复现的这题也是大同小异,一起来整一下。_原生jackson 反序列化链子

一文搞懂SpringCloud,详解干货,做好笔记_spring cloud-程序员宅基地

文章浏览阅读734次,点赞9次,收藏7次。微服务架构简单的说就是将单体应用进一步拆分,拆分成更小的服务,每个服务都是一个可以独立运行的项目。这么多小服务,如何管理他们?(服务治理 注册中心[服务注册 发现 剔除])这么多小服务,他们之间如何通讯?这么多小服务,客户端怎么访问他们?(网关)这么多小服务,一旦出现问题了,应该如何自处理?(容错)这么多小服务,一旦出现问题了,应该如何排错?(链路追踪)对于上面的问题,是任何一个微服务设计者都不能绕过去的,因此大部分的微服务产品都针对每一个问题提供了相应的组件来解决它们。_spring cloud

Js实现图片点击切换与轮播-程序员宅基地

文章浏览阅读5.9k次,点赞6次,收藏20次。Js实现图片点击切换与轮播图片点击切换<!DOCTYPE html><html> <head> <meta charset="UTF-8"> <title></title> <script type="text/ja..._点击图片进行轮播图切换

tensorflow-gpu版本安装教程(过程详细)_tensorflow gpu版本安装-程序员宅基地

文章浏览阅读10w+次,点赞245次,收藏1.5k次。在开始安装前,如果你的电脑装过tensorflow,请先把他们卸载干净,包括依赖的包(tensorflow-estimator、tensorboard、tensorflow、keras-applications、keras-preprocessing),不然后续安装了tensorflow-gpu可能会出现找不到cuda的问题。cuda、cudnn。..._tensorflow gpu版本安装

随便推点

物联网时代 权限滥用漏洞的攻击及防御-程序员宅基地

文章浏览阅读243次。0x00 简介权限滥用漏洞一般归类于逻辑问题,是指服务端功能开放过多或权限限制不严格,导致攻击者可以通过直接或间接调用的方式达到攻击效果。随着物联网时代的到来,这种漏洞已经屡见不鲜,各种漏洞组合利用也是千奇百怪、五花八门,这里总结漏洞是为了更好地应对和预防,如有不妥之处还请业内人士多多指教。0x01 背景2014年4月,在比特币飞涨的时代某网站曾经..._使用物联网漏洞的使用者

Visual Odometry and Depth Calculation--Epipolar Geometry--Direct Method--PnP_normalized plane coordinates-程序员宅基地

文章浏览阅读786次。A. Epipolar geometry and triangulationThe epipolar geometry mainly adopts the feature point method, such as SIFT, SURF and ORB, etc. to obtain the feature points corresponding to two frames of images. As shown in Figure 1, let the first image be ​ and th_normalized plane coordinates

开放信息抽取(OIE)系统(三)-- 第二代开放信息抽取系统(人工规则, rule-based, 先抽取关系)_语义角色增强的关系抽取-程序员宅基地

文章浏览阅读708次,点赞2次,收藏3次。开放信息抽取(OIE)系统(三)-- 第二代开放信息抽取系统(人工规则, rule-based, 先关系再实体)一.第二代开放信息抽取系统背景​ 第一代开放信息抽取系统(Open Information Extraction, OIE, learning-based, 自学习, 先抽取实体)通常抽取大量冗余信息,为了消除这些冗余信息,诞生了第二代开放信息抽取系统。二.第二代开放信息抽取系统历史第二代开放信息抽取系统着眼于解决第一代系统的三大问题: 大量非信息性提取(即省略关键信息的提取)、_语义角色增强的关系抽取

10个顶尖响应式HTML5网页_html欢迎页面-程序员宅基地

文章浏览阅读1.1w次,点赞6次,收藏51次。快速完成网页设计,10个顶尖响应式HTML5网页模板助你一臂之力为了寻找一个优质的网页模板,网页设计师和开发者往往可能会花上大半天的时间。不过幸运的是,现在的网页设计师和开发人员已经开始共享HTML5,Bootstrap和CSS3中的免费网页模板资源。鉴于网站模板的灵活性和强大的功能,现在广大设计师和开发者对html5网站的实际需求日益增长。为了造福大众,Mockplus的小伙伴整理了2018年最..._html欢迎页面

计算机二级 考试科目,2018全国计算机等级考试调整,一、二级都增加了考试科目...-程序员宅基地

文章浏览阅读282次。原标题:2018全国计算机等级考试调整,一、二级都增加了考试科目全国计算机等级考试将于9月15-17日举行。在备考的最后冲刺阶段,小编为大家整理了今年新公布的全国计算机等级考试调整方案,希望对备考的小伙伴有所帮助,快随小编往下看吧!从2018年3月开始,全国计算机等级考试实施2018版考试大纲,并按新体系开考各个考试级别。具体调整内容如下:一、考试级别及科目1.一级新增“网络安全素质教育”科目(代..._计算机二级增报科目什么意思

conan简单使用_apt install conan-程序员宅基地

文章浏览阅读240次。conan简单使用。_apt install conan