003 Spring注解

文章目录

- @PathVariable和@RequestParam
- - [@PathVariable 示例](#@PathVariable 示例)
  - [@RequestParam 示例](#@RequestParam 示例)
- @GetMapping、@PostMapping、@PutMapping、@DeleteMapping
- - [1. `@GetMapping`](#1. @GetMapping)
  - [2. `@PostMapping`](#2. @PostMapping)
  - [3. `@PutMapping`](#3. @PutMapping)
  - [4. `@DeleteMapping`](#4. @DeleteMapping)
  - 总结
- @Autowired和@Resource
- - @Autowired
  - @Resource
  - - [1. @Resource的作用](#1. @Resource的作用)
    - [2. @Resource的用法](#2. @Resource的用法)
    - [3. @Resource的属性](#3. @Resource的属性)
    - [4. @Resource与其他注解的区别](#4. @Resource与其他注解的区别)
    - [5. 使用注意事项](#5. 使用注意事项)
    - [6. 常见问题及解决方案](#6. 常见问题及解决方案)
- @RequestBody和@ResonseBody
- - @RequestBody
  - - [1. @RequestBody的作用](#1. @RequestBody的作用)
    - [2. 使用场景](#2. 使用场景)
    - [3. 如何使用](#3. 如何使用)
    - [4. 注意事项](#4. 注意事项)
    - [5. 示例请求与响应](#5. 示例请求与响应)
  - @ResponseBody
  - - [1. @ResponseBody的作用](#1. @ResponseBody的作用)
    - [2. 如何使用](#2. 如何使用)
    - [3. 与@RestController的结合](#3. 与@RestController的结合)
    - [4. 注意事项](#4. 注意事项)
    - [5. 示例请求与响应](#5. 示例请求与响应)
- [@SpringBootApplication @Configuration @EnableAutoConfiguration @ComponentScan](#@SpringBootApplication @Configuration @EnableAutoConfiguration @ComponentScan)

@PathVariable和@RequestParam

在Java中，@PathVariable 和 @RequestParam 是Spring MVC框架中用于获取HTTP请求中参数的注解。

@PathVariable 通常用于RESTful风格的URL，从URL的路径中捕获变量的值。
@RequestParam 用于获取查询参数，也就是URL中?后面的参数。

下面是一些代码示例来解释这两个注解的用法。

@PathVariable 示例

假设你有一个RESTful API，URL路径为/users/{userId}，其中{userId}是一个动态部分，表示用户的ID。你可以使用@PathVariable来获取这个ID。

java 复制代码

@RestController  
@RequestMapping("/users")  
public class UserController {  
  
    @GetMapping("/{userId}")  
    public ResponseEntity<String> getUser(@PathVariable("userId") String userId) {  
        // 在这里，userId变量将包含URL中的用户ID值  
        return ResponseEntity.ok("User ID is: " + userId);  
    }  
}

在这个例子中，当你访问/users/123时，getUser方法会被调用，并且userId参数的值会被设置为"123"。

@RequestParam 示例

假设你有一个API，其URL路径为/search，并且你希望通过查询参数来传递搜索关键字。你可以使用@RequestParam来获取这个参数。

java 复制代码

@RestController  
@RequestMapping("/search")  
public class SearchController {  
  
    @GetMapping  
    public ResponseEntity<String> search(@RequestParam("query") String query) {  
        // 在这里，query变量将包含查询参数的值  
        return ResponseEntity.ok("Search query is: " + query);  
    }  
}

在这个例子中，当你访问/search?query=example时，search方法会被调用，并且query参数的值会被设置为"example"。

你也可以为@RequestParam指定一个默认值，以便在请求中没有提供该参数时使用：

java 复制代码

@GetMapping  
public ResponseEntity<String> search(@RequestParam(value = "query", defaultValue = "defaultQuery") String query) {  
    // ...  
}

在这个修改后的例子中，如果你访问/search而没有提供query参数，那么query变量的值将被设置为"defaultQuery"。

@GetMapping、@PostMapping、@PutMapping、@DeleteMapping

在Java的Spring框架中，@GetMapping、@PostMapping、@PutMapping和@DeleteMapping是特殊的注解，用于简化RESTful Web服务的创建。这些注解都是基于HTTP的方法（也称为HTTP动词），它们分别对应HTTP协议中的GET、POST、PUT和DELETE请求。

1. `@GetMapping`

@GetMapping用于处理HTTP GET请求。GET请求通常用于请求数据，不应对服务器上的数据进行修改。在RESTful服务中，GET请求通常用于检索资源。

示例：

java 复制代码

@GetMapping("/users/{id}")  
public User getUser(@PathVariable Long id) {  
    // 根据id获取用户信息并返回  
    return userService.findUserById(id);  
}

2. `@PostMapping`

@PostMapping用于处理HTTP POST请求。POST请求通常用于提交数据，例如在服务器上创建新的资源。在RESTful服务中，POST请求通常用于添加新的资源。

示例：

java 复制代码

@PostMapping("/users")  
public User createUser(@RequestBody User user) {  
    // 创建新用户并返回  
    return userService.createUser(user);  
}

3. `@PutMapping`

@PutMapping用于处理HTTP PUT请求。PUT请求通常用于更新资源。在RESTful服务中，PUT请求用于更新现有资源的状态或信息。

示例：

java 复制代码

@PutMapping("/users/{id}")  
public User updateUser(@PathVariable Long id, @RequestBody User user) {  
    // 更新指定id的用户信息并返回更新后的用户  
    return userService.updateUser(id, user);  
}

4. `@DeleteMapping`

@DeleteMapping用于处理HTTP DELETE请求。DELETE请求用于删除资源。在RESTful服务中，DELETE请求用于移除某个资源。

示例：

java 复制代码

@DeleteMapping("/users/{id}")  
public void deleteUser(@PathVariable Long id) {  
    // 删除指定id的用户  
    userService.deleteUser(id);  
}

总结

@GetMapping：用于获取资源，通常是只读操作。
@PostMapping：用于创建新资源。
@PutMapping：用于更新现有资源。
@DeleteMapping：用于删除资源。

这些注解简化了Spring MVC中控制器方法的映射，使得开发者能够更清晰地表达他们的意图，同时也减少了配置的工作量。每个注解都对应一个特定的HTTP方法，这有助于实现RESTful Web服务的原则，即使用HTTP方法来反映对资源的操作类型。

@Autowired和@Resource

@Autowired

@Autowired 是 Spring Framework 中的一个注解，用于实现自动装配（Dependency Injection, DI），也就是自动将依赖注入到需要的组件中。这个注解可以极大地简化 Spring 应用程序的配置，并使得代码更加模块化和可测试。

使用场景

在 Spring 应用程序中，当某个类依赖于其他类或者接口时，我们通常不希望直接在代码中通过new关键字来创建这些依赖的实例。这样做会使得代码之间高度耦合，不便于测试和维护。相反，我们希望通过 Spring 容器来管理这些依赖，并在需要的时候自动将它们注入到相应的类中。这就是@Autowired注解发挥作用的地方。

如何使用

@Autowired可以用在类的构造器、字段或者 setter 方法上。

构造器注入：

在类的构造器上使用@Autowired注解，Spring 容器会自动调用这个构造器，并传入所需的依赖。

java 复制代码

@Service  
public class MyService {  
    private final MyRepository repository;  
  
    @Autowired  
    public MyService(MyRepository repository) {  
        this.repository = repository;  
    }  
}

字段注入：

直接在字段上使用@Autowired注解，Spring 容器会自动为该字段赋值。

java 复制代码

@Service  
public class MyService {  
    @Autowired  
    private MyRepository repository;  
}

Setter 方法注入：

在 setter 方法上使用@Autowired注解，Spring 容器会自动调用该方法，并传入所需的依赖。

java 复制代码

@Service  
public class MyService {  
    private MyRepository repository;  
  
    @Autowired  
    public void setRepository(MyRepository repository) {  
        this.repository = repository;  
    }  
}

注意事项

类型匹配 ：当使用@Autowired时，Spring 容器会查找匹配的 Bean 来注入。如果存在多个相同类型的 Bean，需要通过@Qualifier注解来指定具体的 Bean 名称。
可选性 ：从 Spring 4.3 开始，如果类只有一个构造器，那么@Autowired注解是可以省略的，Spring 会自动识别并使用这个构造器进行依赖注入。
字段注入的争议：虽然字段注入简洁明了，但有些开发者认为它破坏了封装性，使得测试变得更加困难。因此，构造器注入通常被认为是更好的做法。
与@Resource的区别 ：@Autowired是基于类型的注入，而@Resource可以基于类型或名称进行注入。两者在功能上相似，但@Autowired是 Spring 特有的，而@Resource是来自于 JSR-250 规范。

总的来说，@Autowired是 Spring 中实现依赖注入的重要工具之一，它简化了配置，提高了代码的可维护性和可测试性。

@Resource

在Java中，@Resource注解是用于实现依赖注入的一种机制，它属于Java EE规范的一部分，也在Spring框架等中得到广泛应用。以下是关于@Resource的详细讲解：

1. @Resource的作用

@Resource注解主要用于依赖注入，它可以将一个类所需要的依赖对象自动注入到该类中。这样做可以避免手动创建和配置对象的繁琐过程，使开发者能够更专注于业务逻辑的开发。

2. @Resource的用法

@Resource注解可以用在字段、setter方法或构造函数上：

字段注入 ：直接在类的字段上使用@Resource注解，容器会自动为该字段注入匹配的依赖对象。

java 复制代码

import javax.annotation.Resource;  
  
public class MyService {  
    @Resource(name = "myRepositoryBean") // 使用name属性指定Bean的名称  
    private MyRepository myRepository;  
  
    // ... 其他方法和逻辑  
}

或者，如果不指定name，则可以根据类型自动注入：

java 复制代码

import javax.annotation.Resource;  
  
public class MyService {  
    @Resource // 根据MyRepository类型自动注入  
    private MyRepository myRepository;  
  
    // ... 其他方法和逻辑  
}

Setter方法注入 ：在setter方法上使用@Resource注解，容器会调用该方法并将依赖对象作为参数传入。

java 复制代码

import javax.annotation.Resource;  
  
public class MyService {  
    private MyRepository myRepository;  
  
    @Resource(name = "myRepositoryBean") // 使用name属性指定Bean的名称  
    public void setMyRepository(MyRepository myRepository) {  
        this.myRepository = myRepository;  
    }  
  
    // ... 其他方法和逻辑  
}

构造函数注入 ：在构造函数上使用@Resource注解，容器会调用该构造函数并将依赖对象作为参数传入。

虽然@Resource通常不用于构造函数注入，因为它主要用于字段和Setter注入，但如果你确实想通过构造函数注入，可以结合使用@Resource和其他注解（如@Qualifier）或者在Spring配置中明确指定构造函数参数。不过，通常情况下，我们会使用@Autowired来进行构造函数注入。

如果你依然想使用@Resource进行构造函数注入，可以这样做，但通常不推荐
java 复制代码
```
import javax.annotation.Resource;  
  
public class MyService {  
    private final MyRepository myRepository;  
  
    @Resource // 这不是典型的用法，更常见的是使用@Autowired进行构造函数注入  
    public MyService(MyRepository myRepository) {  
        this.myRepository = myRepository;  
    }  
  
    // ... 其他方法和逻辑  
}
```
请注意，在Spring中，通常推荐使用@Autowired进行构造函数注入，因为它提供了更明确的依赖注入语义，并且可以确保所有的依赖项在对象创建时就已经被注入，从而保证了对象的不可变性和线程安全。

如果你正在使用Spring，并且想要通过构造函数注入依赖项，那么更标准的做法是使用@Autowired注解，如下所示：
java 复制代码
```
import org.springframework.beans.factory.annotation.Autowired;  
  
public class MyService {  
    private final MyRepository myRepository;  
  
    @Autowired // 使用@Autowired进行构造函数注入  
    public MyService(MyRepository myRepository) {  
        this.myRepository = myRepository;  
    }  
  
    // ... 其他方法和逻辑  
}
```
在这种情况下，Spring会自动寻找匹配的Bean来注入到构造函数中。如果有多个相同类型的Bean，你可以使用@Qualifier注解来指定具体的Bean。

3. @Resource的属性

@Resource注解有两个重要的属性：name和type。

name：用于指定依赖对象的名称。如果容器中存在一个与指定名称相匹配的Bean，则将其注入。
type：用于指定依赖对象的类型。当没有指定name属性，或者找不到与name属性匹配的Bean时，容器会根据type属性来寻找匹配的Bean。

4. @Resource与其他注解的区别

与@Autowired相比，@Resource注解的区别主要在于：

@Autowired ：是基于类型的注入，它会自动装配与注入点类型匹配的Bean。如果存在多个相同类型的Bean，则需要使用@Qualifier注解来指定具体的Bean。
@Resource：可以基于类型或名称进行注入。它首先根据name属性进行匹配，如果找不到匹配的Bean，再根据type属性进行匹配。

5. 使用注意事项

确保在正确的位置使用@Resource注解，例如字段、setter方法或构造函数上。
注意指定正确的资源名称和资源类型，以确保能够注入正确的依赖对象。
在使用@Resource注解时，要确保所需的依赖对象在容器中已定义且可用。

6. 常见问题及解决方案

如果遇到@Resource注解无法使用或失败的情况，首先检查JDK版本是否支持该注解，推荐使用的JDK版本是1.8。
如果JDK版本无误，但问题仍然存在，可以尝试引入javax.annotation-api依赖包。
检查是否存在jar包冲突，例如重复导入了含有javax.annotation的依赖包，这可能导致冲突。解决方法是删除重复的jar包或解决冲突。

总的来说，@Resource注解是Java中进行依赖注入的一种重要方式，它简化了对象的创建和配置过程，使开发者能够更专注于业务逻辑的实现。

@RequestBody和@ResonseBody

@RequestBody

在Java中，特别是在Spring框架中，@RequestBody是一个常用的注解，主要用于处理HTTP请求体中的数据。它常常与@RequestMapping或@PostMapping等注解一起使用，以指示一个方法参数应该被绑定到HTTP请求体。以下是关于@RequestBody的详细讲解：

1. @RequestBody的作用

@RequestBody注解的主要作用是将客户端发送的HTTP请求体中的数据绑定到控制器方法的参数上。这通常用于处理POST、PUT等请求中发送的JSON或XML数据。

2. 使用场景

当你需要接收客户端发送的复杂数据结构（如JSON对象）时，@RequestBody非常有用。它告诉Spring框架，应该使用HTTP消息转换器（如MappingJackson2HttpMessageConverter）来解析请求体中的数据，并将其转换为相应的Java对象。

3. 如何使用

在控制器方法中添加@RequestBody注解，并将其应用于需要接收请求体数据的参数上。例如：

java 复制代码

@RestController  
@RequestMapping("/api/users")  
public class UserController {  
  
    @PostMapping  
    public User createUser(@RequestBody User user) {  
        // 处理user对象，例如保存到数据库  
        // ...  
        return user; // 假设这里直接返回接收到的用户对象作为响应  
    }  
}  
  
public class User {  
    private String name;  
    private int age;  
    // getters, setters, etc.  
}

在上面的例子中，当客户端向/api/users发送POST请求，并附带一个JSON格式的User对象时，Spring将使用Jackson等库自动将JSON数据转换为User类的实例，并将其作为参数传递给createUser方法。

4. 注意事项

确保你的项目中已经包含了处理JSON（或其他媒体类型）的依赖库，如Jackson。
@RequestBody通常与@PostMapping、@PutMapping等注解一起使用，因为这些HTTP方法通常包含请求体。
如果请求体中的数据格式与目标Java类的结构不匹配，或者数据格式有误，Spring将抛出一个异常。
你可以通过自定义HttpMessageConverter来支持不同的数据格式转换。

5. 示例请求与响应

假设你有以下JSON数据，并准备通过POST请求发送到/api/users：

json 复制代码

{  
    "name": "John Doe",  
    "age": 30  
}

当你发送这个请求时，Spring将自动将这个JSON对象转换为User类的实例，并传递给createUser方法。如果一切正常，你将收到与请求体相同的JSON数据作为响应（根据上面的示例代码）。

总的来说，@RequestBody是Spring框架中处理HTTP请求体数据的重要工具，它大大简化了从JSON等数据格式到Java对象的转换过程。

@ResponseBody

在Java的Spring框架中，@ResponseBody注解用于将控制器方法的返回值直接写入HTTP响应体中，而不是解析为跳转路径。这意味着，当你希望直接返回数据（如JSON、XML等）给客户端时，可以使用@ResponseBody注解。

1. @ResponseBody的作用

直接返回数据 ：通常，在Spring MVC中，控制器方法的返回值会被解析为一个视图名称，然后Spring MVC会根据该名称找到对应的视图进行渲染。但是，当你使用了@ResponseBody注解后，方法的返回值将不会被解析为视图名称，而是直接写入到HTTP响应中。
简化响应流程：它使得从控制器直接返回数据变得简单，无需配置额外的视图解析器。
支持多种数据格式 ：可以结合Spring的消息转换器（如MappingJackson2HttpMessageConverter），自动将数据转换为JSON、XML等格式返回给客户端。

2. 如何使用

在控制器方法上使用@ResponseBody注解即可，例如：

java 复制代码

@Controller  
@RequestMapping("/api")  
public class MyController {  
  
    @ResponseBody  
    @GetMapping("/hello")  
    public Map<String, Object> sayHello() {  
        Map<String, Object> result = new HashMap<>();  
        result.put("message", "Hello, World!");  
        return result;  
    }  
}

在上面的例子中，当访问/api/hello时，控制器方法sayHello会返回一个包含"message": "Hello, World!"的Map对象。由于方法上使用了@ResponseBody注解，这个Map对象会被自动转换为JSON格式（如果项目中配置了JSON消息转换器）并返回给客户端。

3. 与@RestController的结合

在Spring 4.0及以后的版本中，引入了一个新的注解@RestController，它是@Controller和@ResponseBody的组合。这意味着，在一个类上使用@RestController注解后，该类中的所有方法都会默认使用@ResponseBody，无需在每个方法上单独添加。

java 复制代码

@RestController  
@RequestMapping("/api")  
public class MyRestController {  
  
    @GetMapping("/hello")  
    public Map<String, Object> sayHello() {  
        Map<String, Object> result = new HashMap<>();  
        result.put("message", "Hello, World!");  
        return result;  
    }  
}

在上面的@RestController例子中，sayHello方法同样会返回一个JSON对象给客户端，而无需在方法上显式使用@ResponseBody注解。

4. 注意事项

确保项目中已经包含了处理JSON（或其他媒体类型）的依赖库，如Jackson或Gson。
如果返回的对象不能被序列化为JSON（例如，包含无法序列化的属性），则会抛出异常。
可以通过配置不同的消息转换器来支持多种数据格式的转换。

5. 示例请求与响应

当你访问/api/hello时，将会收到如下JSON响应：

json 复制代码

{  
    "message": "Hello, World!"  
}

总结来说，@ResponseBody注解在Spring MVC中用于直接将控制器方法的返回值作为HTTP响应体返回给客户端，通常与JSON或XML等数据格式结合使用，以便客户端能够方便地解析和处理这些数据。而@RestController是@Controller和@ResponseBody的便捷组合，特别适用于构建RESTful Web服务。

@SpringBootApplication @Configuration @EnableAutoConfiguration @ComponentScan

当你在Java中使用Spring Boot来开发应用程序时，你经常会遇到@SpringBootApplication、@Configuration、@EnableAutoConfiguration和@ComponentScan这些注解。以下是对这些注解的详细讲解：

@SpringBootApplication :
- 这是一个组合注解，它组合了以下三个核心注解：@Configuration、@EnableAutoConfiguration和@ComponentScan。
- 使用@SpringBootApplication注解一个类，通常表示这个类是Spring Boot应用的主类，并且该类通常包含main方法作为应用程序的入口。
- 因为@SpringBootApplication已经包含了其他三个注解，所以在大多数情况下，你只需使用这一个注解就足够了。
@Configuration :
- 这个注解表明该类是一个配置类，用于定义Spring的Bean。
- 在配置类中，你可以使用@Bean注解来声明一个或多个Bean，这些Bean将被Spring容器管理。
- 通常在Spring Boot应用中，主类上会使用@Configuration注解，但如果你有其他专门的配置类，也可以在这些类上使用此注解。
@EnableAutoConfiguration :
- 这个注解告诉Spring Boot根据你添加的依赖自动配置你的应用程序。
- 例如，如果你在pom.xml或build.gradle中添加了spring-boot-starter-web依赖，Spring Boot会自动配置与Web相关的Bean，如DispatcherServlet、EmbeddedServletContainer等。
- @EnableAutoConfiguration会尝试根据你添加的jar依赖自动配置你的Spring应用。
@ComponentScan :
- 这个注解告诉Spring在哪些包中查找带有@Component、@Service、@Repository和@Controller等注解的类，并将这些类注册为Spring容器中的Bean。
- 默认情况下，@ComponentScan会扫描当前包和子包中的组件。
- 如果你需要扫描其他包，可以通过设置basePackages属性来指定。

在使用Spring Boot开发应用时，通常你只需要在主类上使用@SpringBootApplication注解，因为它已经涵盖了其他三个注解的功能。但是，了解这些注解的单独作用对于更深入地理解Spring Boot的工作原理是非常有帮助的。

示例：

java 复制代码

import org.springframework.boot.SpringApplication;  
import org.springframework.boot.autoconfigure.SpringBootApplication;  
  
@SpringBootApplication  
public class MyApplication {  
    public static void main(String[] args) {  
        SpringApplication.run(MyApplication.class, args);  
    }  
}

在上面的示例中，@SpringBootApplication注解已经足够启动一个Spring Boot应用，并自动配置所需的组件。

文章目录

@PathVariable和@RequestParam

@PathVariable 示例

@RequestParam 示例

@GetMapping、@PostMapping、@PutMapping、@DeleteMapping

1. @GetMapping

2. @PostMapping

3. @PutMapping

4. @DeleteMapping

总结

@Autowired和@Resource

@Autowired

使用场景

如何使用

注意事项

@Resource

1. @Resource的作用

2. @Resource的用法

3. @Resource的属性

4. @Resource与其他注解的区别

5. 使用注意事项

6. 常见问题及解决方案

@RequestBody和@ResonseBody

@RequestBody

1. @RequestBody的作用

2. 使用场景

3. 如何使用

4. 注意事项

5. 示例请求与响应

@ResponseBody

1. @ResponseBody的作用

2. 如何使用

3. 与@RestController的结合

4. 注意事项

5. 示例请求与响应

@SpringBootApplication @Configuration @EnableAutoConfiguration @ComponentScan

1. `@GetMapping`

2. `@PostMapping`

3. `@PutMapping`

4. `@DeleteMapping`