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

智能推荐

openstack认证服务(认证组件)3_openstack 认证服务-程序员宅基地

文章浏览阅读1.9k次。Openstack认证服务(认证组件)3_openstack 认证服务

职场生存法则:一个外企女白领的日记...-程序员宅基地

文章浏览阅读4.5k次。第11节:人与人的相处(1)   2006-6-7 8∶40∶00  人与人的相处  一、有后台的下属。  我遇见过,也处理得很好。你不能得罪他背后的人,那么就通过他去利用他背后的人。比如说他是老板的亲戚,碰见别的部门有什么搞不定的人,你美言他几句叫他去搞,成功了自然是别人给老板面子,失败了你也可以多多积累他的错误,日后真到不得不踢人的时候也派得上..._外企重视documentation

iOS踩坑App Store Connect Operation Error_sdk version issue. this app was built with the ios-程序员宅基地

文章浏览阅读3.4k次。这个应用程序是用iOS 15.5 SDK构建的。从2023年4月开始,所有提交到应用商店的iOS应用程序都必须使用iOS 16.1 SDK或更高版本构建,包括在Xcode 14.1或更高版本中。目前iOS 开发工具Xcode 版本号是13.4.1 ,系统无法升级,也会导致Xcode无法升级。1、苹果官方提示: 2023年4月开始,开发必须使用 Xcode 14.1 以上的版本,2、目前此电脑无法在升级, 2023年4月开始 ,此电脑就无法正常开发使用,应用程序商店连接操作错误。_sdk version issue. this app was built with the ios 15.5 sdk. all ios and ipa

接单平台汇总_excel接单平台-程序员宅基地

文章浏览阅读335次。接单平台汇总程序员客栈码市开源众包智慧外包实现网猿急送人人开发网开发邦点鸭网快码网英选网外包大师我爱方案网智筹网自由智客接单注意事项:1、没有第三方担保的个人单子,尽量少接2、无需求文档、没有具体要求的不接3、没有预付的不做,尽量用442的分步步骤方式4、没有金刚钻,别揽瓷器活5、急单勿接6、任何不付定金的单子都是耍赖7、不计得失,不怕吃亏..._excel接单平台

CPU如何跑分_cpu跑分教程-程序员宅基地

文章浏览阅读1k次。烤CPU的时候,占用率满了,CPU频率的槽有一些还是空的…… 有没有能跑分的软件?好像有的【聊电Jing】你的CPU性能如何? 来跑个分测试看看吧! | Cinebench R15 & R20 使用教学_哔哩哔哩_bilibili 好像还是免费的Cinebench - Maxon Cinebench - Microsoft Store Apps 频率为什么就是超不过3Ghz? 多核,100度了? 可能频率最高只能这么高,再高可能就烧掉了…… 多核结果.................._cpu跑分教程

最大流问题的Ford-Fulkerson解法_ford capacity 详解-程序员宅基地

文章浏览阅读498次。这是一种方法,而不是算法,因为它包含具有不同运行时间的几种实现。该方法依赖于三种重要思想:残留网络,增广路径和割我们先简单介绍下Ford-Fulkerson方法的基本思想。首先需要了解的是Ford-Fulkerson是一种迭代的方法。开始时,对所有的u,v属于V,f(u,v)=0(这里f(u,v)代表u到v的边当前流量),即初始状态时流的值为0。在每次迭代中,可以通过寻找一个“增广路径”来增加_ford capacity 详解

随便推点

VisualVM 插件地址_visualvm 插件中心地址-程序员宅基地

文章浏览阅读1.4k次。VisualVM原插件地址是oracle的打不开,已经移到github上了,具体如下:介绍:https://visualvm.github.io/plugins.html下载地址:https://visualvm.github.io/pluginscenters.html 选择对应JDK版本下载即可! 注意事项:在使用Visual VM进行heapdump分析的时候,发..._visualvm 插件中心地址

understand 代码解析工具的使用_understand代码-程序员宅基地

文章浏览阅读8.8k次,点赞15次,收藏80次。understand 常用操作文章目录understand 常用操作简单介绍软件下载常用基本操作新建工程并添加现有文件如何找到自己当前想要去编辑的文件?如何在当前文件中找到你要编辑的函数?如何跳转到定义?查看当前文件的函数列表如何查看函数都被谁调用了?查看函数的调用逻辑如何查找如何找到函数的被调用图除此之外可以分析出代码的各种结构文本的编辑格式设置双屏一边看代码,一遍看代码地图简单介绍understand对分析代码有非常强的能力,完全可以代替sourceinsight,并且可以在linux上mac上使_understand代码

Oracle 闪回(flashback)数据库到指定时间点_数据库 oracle时间戳闪回-程序员宅基地

文章浏览阅读4.1k次。如果是update,delete类误操作且已经commit,优先考虑使用flashback query进行恢复。select * from test1 as of timestamp to_timestamp('2018-01-13 16:59:29','YYYY-MM-DD hh24:mi:ss');如果是drop或truncate table,则不能使用闪回查询,需要使用备库进行整库..._数据库 oracle时间戳闪回

[bigdata-124] docker+django2.0 构建web服务_docker django print-程序员宅基地

文章浏览阅读660次。在本地运行django1.python3.42.安装django,安装特定版本pip3 install django==2.03.测试安装python3import djangoprint(django.get_version())4.django使用创建一个新目录test_djangopython -m django --version_docker django print

话题的发布与订阅_话题订阅频率和发布频率一样-程序员宅基地

文章浏览阅读2.6k次,点赞3次,收藏11次。Ros话题发布与订阅节点的编写(C++)_话题订阅频率和发布频率一样

Qt Creator 安装 VLD_qtcreater vld-程序员宅基地

文章浏览阅读509次。Qt Creator 安装 VLD2015-04-14 16:52:55你好L阅读数 2325更多分类专栏:qt版权声明:本文为博主原创文章,遵循CC 4.0 BY-SA版权协议,转载请附上原文出处链接和本声明。本文链接:https://blog.csdn.net/lin_jianbin/article/details/45044459一、环境说明1、VLD内存..._qtcreater vld

推荐文章

热门文章

相关标签