@RequestAttribute 注解案例说明

@RequestAttribute注解，它用于将 Web 请求的属性注入到控制器方法的参数中。这在处理需要访问特定请求属性的场景中非常有用，例如在表单提交、文件上传或自定义请求处理中。

注解结构

业务场景：

假设你正在开发一个在线文档编辑器，用户可以上传文档并对其进行编辑。在用户上传文档后，你需要将文档保存在服务器上，并在用户编辑文档时提供文档的版本控制。

1. 上传文档并使用 @RequestAttribute 注解：

import org.springframework.web.bind.annotation.*;
import org.springframework.web.multipart.MultipartFile;

@Controller
public class DocumentUploadController {

    @PostMapping("/upload")
    public String handleFileUpload(@RequestParam("document") MultipartFile file,
                                   @RequestAttribute(name = "userId", required = false) Long userId) {
        // 检查用户是否已登录，userId 可能为 null
        if (userId != null) {
            // 用户已登录，保存文档到用户目录
            documentService.saveDocument(file, userId);
        } else {
            // 用户未登录，保存文档到公共目录
            documentService.saveDocument(file, null);
        }
        return "redirect:/documents";
    }
}

在这个例子中，@RequestAttribute 注解用于从请求中获取 userId 属性。这个属性可能在之前的请求处理中被设置，例如在安全认证过滤器中。

2. 设置请求属性的示例：

public class SecurityFilter implements Filter {

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {
        HttpServletRequest httpRequest = (HttpServletRequest) request;
        // 假设从 Session 中获取用户 ID
        Long userId = (Long) httpRequest.getSession().getAttribute("userId");
        request.setAttribute("userId", userId);
        chain.doFilter(request, response);
    }
}

3. 文档服务层实现：

@Service
public class DocumentService {

    public void saveDocument(MultipartFile file, Long userId) {
        // 根据 userId 保存文档到不同的目录
        String filePath = (userId != null) ? "/user/" + userId : "public";
        // 实际的文件保存逻辑
    }
}

4. 表单 HTML：

<form action="/upload" method="post" enctype="multipart/form-data">
    <input type="file" name="document" required>
    <button type="submit">Upload Document</button>
</form>

5. 客户端上传文档：

用户选择一个文档并提交表单，表单数据作为 MultipartFile 发送到服务器。

注解属性说明

@RequestAttribute 注解的属性说明：

1. name:

   • 类型：String
   • 作用：指定要注入的请求属性的名称。如果未指定或为空字符串，默认使用方法参数的名称。

2. value:

   • 类型：String
   • 作用：为注入的属性提供一个别名。如果指定了 name 属性，则 value 被忽略。

3. required:

   • 类型：boolean
   • 默认值：true
   • 作用：指示是否必须在请求属性中找到指定的属性。如果设置为 true 且请求中没有找到属性，则会抛出一个异常。如果设置为 false，则在找不到属性时注入 null。

总结：

• @RequestAttribute 注解允许开发者访问在请求处理过程中设置的属性，无论这些属性是如何设置的。
• 它提供了一种灵活的方式来访问和使用请求属性，而不需要关心属性的来源。
• 使用 @RequestAttribute 注解可以提高代码的可读性和可维护性，尤其是在处理复杂的请求属性时。