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

智能推荐

Docker 快速上手学习入门教程_docker菜鸟教程-程序员宅基地

文章浏览阅读2.5w次,点赞6次,收藏50次。官方解释是,docker 容器是机器上的沙盒进程,它与主机上的所有其他进程隔离。所以容器只是操作系统中被隔离开来的一个进程,所谓的容器化,其实也只是对操作系统进行欺骗的一种语法糖。_docker菜鸟教程

电脑技巧:Windows系统原版纯净软件必备的两个网站_msdn我告诉你-程序员宅基地

文章浏览阅读5.7k次,点赞3次,收藏14次。该如何避免的,今天小编给大家推荐两个下载Windows系统官方软件的资源网站,可以杜绝软件捆绑等行为。该站提供了丰富的Windows官方技术资源,比较重要的有MSDN技术资源文档库、官方工具和资源、应用程序、开发人员工具(Visual Studio 、SQLServer等等)、系统镜像、设计人员工具等。总的来说,这两个都是非常优秀的Windows系统镜像资源站,提供了丰富的Windows系统镜像资源,并且保证了资源的纯净和安全性,有需要的朋友可以去了解一下。这个非常实用的资源网站的创建者是国内的一个网友。_msdn我告诉你

vue2封装对话框el-dialog组件_<el-dialog 封装成组件 vue2-程序员宅基地

文章浏览阅读1.2k次。vue2封装对话框el-dialog组件_

MFC 文本框换行_c++ mfc同一框内输入二行怎么换行-程序员宅基地

文章浏览阅读4.7k次,点赞5次,收藏6次。MFC 文本框换行 标签: it mfc 文本框1.将Multiline属性设置为True2.换行是使用"\r\n" (宽字符串为L"\r\n")3.如果需要编辑并且按Enter键换行,还要将 Want Return 设置为 True4.如果需要垂直滚动条的话将Vertical Scroll属性设置为True,需要水平滚动条的话将Horizontal Scroll属性设_c++ mfc同一框内输入二行怎么换行

redis-desktop-manager无法连接redis-server的解决方法_redis-server doesn't support auth command or ismis-程序员宅基地

文章浏览阅读832次。检查Linux是否是否开启所需端口,默认为6379,若未打开,将其开启:以root用户执行iptables -I INPUT -p tcp --dport 6379 -j ACCEPT如果还是未能解决,修改redis.conf,修改主机地址:bind 192.168.85.**;然后使用该配置文件,重新启动Redis服务./redis-server redis.conf..._redis-server doesn't support auth command or ismisconfigured. try

实验四 数据选择器及其应用-程序员宅基地

文章浏览阅读4.9k次。济大数电实验报告_数据选择器及其应用

随便推点

灰色预测模型matlab_MATLAB实战|基于灰色预测河南省社会消费品零售总额预测-程序员宅基地

文章浏览阅读236次。1研究内容消费在生产中占据十分重要的地位,是生产的最终目的和动力,是保持省内经济稳定快速发展的核心要素。预测河南省社会消费品零售总额,是进行宏观经济调控和消费体制改变创新的基础,是河南省内人民对美好的全面和谐社会的追求的要求,保持河南省经济稳定和可持续发展具有重要意义。本文建立灰色预测模型,利用MATLAB软件,预测出2019年~2023年河南省社会消费品零售总额预测值分别为21881...._灰色预测模型用什么软件

log4qt-程序员宅基地

文章浏览阅读1.2k次。12.4-在Qt中使用Log4Qt输出Log文件,看这一篇就足够了一、为啥要使用第三方Log库,而不用平台自带的Log库二、Log4j系列库的功能介绍与基本概念三、Log4Qt库的基本介绍四、将Log4qt组装成为一个单独模块五、使用配置文件的方式配置Log4Qt六、使用代码的方式配置Log4Qt七、在Qt工程中引入Log4Qt库模块的方法八、获取示例中的源代码一、为啥要使用第三方Log库,而不用平台自带的Log库首先要说明的是,在平时开发和调试中开发平台自带的“打印输出”已经足够了。但_log4qt

100种思维模型之全局观思维模型-67_计算机中对于全局观的-程序员宅基地

文章浏览阅读786次。全局观思维模型,一个教我们由点到线,由线到面,再由面到体,不断的放大格局去思考问题的思维模型。_计算机中对于全局观的

线程间控制之CountDownLatch和CyclicBarrier使用介绍_countdownluach于cyclicbarrier的用法-程序员宅基地

文章浏览阅读330次。一、CountDownLatch介绍CountDownLatch采用减法计算;是一个同步辅助工具类和CyclicBarrier类功能类似,允许一个或多个线程等待,直到在其他线程中执行的一组操作完成。二、CountDownLatch俩种应用场景: 场景一:所有线程在等待开始信号(startSignal.await()),主流程发出开始信号通知,既执行startSignal.countDown()方法后;所有线程才开始执行;每个线程执行完发出做完信号,既执行do..._countdownluach于cyclicbarrier的用法

自动化监控系统Prometheus&Grafana_-自动化监控系统prometheus&grafana实战-程序员宅基地

文章浏览阅读508次。Prometheus 算是一个全能型选手,原生支持容器监控,当然监控传统应用也不是吃干饭的,所以就是容器和非容器他都支持,所有的监控系统都具备这个流程,_-自动化监控系统prometheus&grafana实战

React 组件封装之 Search 搜索_react search-程序员宅基地

文章浏览阅读4.7k次。输入关键字,可以通过键盘的搜索按钮完成搜索功能。_react search