【Spring 篇】SpringMVC的请求：舞台上的开端

喜欢ヅ旅行 2024-04-06 15:02 39阅读 0赞

![在这里插入图片描述][00284c26956d4b778c232f61e9bac424.png]

在Web开发的舞台上，请求就如同一场充满激情的开端，而SpringMVC是这场表演的舞台主持人，它能够优雅地接收和处理各种请求，引领我们进入一个美妙的编码之旅。在本篇博客中，我们将深入探讨SpringMVC的请求处理机制，解开其神秘的面纱，让我们一同迈出请求的第一步。

### 控制器方法：开启音乐会的节奏 ###

在SpringMVC中，请求的处理始于控制器方法。控制器方法是一个普通的Java方法，负责处理特定的请求。通过`@Controller`注解标识一个类为控制器，而`@RequestMapping`注解用于映射请求路径。

@Controller
    @RequestMapping("/music")
    public class MusicController {
        
    
        @GetMapping("/play")
        public String playMusic() {
        
            // 处理播放音乐的请求
            return "music-player";
        }
    }

在这个例子中，`MusicController`被标记为`@Controller`，而`@RequestMapping("/music")`指定了该控制器处理的请求路径前缀。`playMusic`方法使用`@GetMapping("/play")`注解表示处理`/music/play`路径的GET请求。当用户访问`/music/play`时，该方法将被调用，然后返回逻辑视图名为"music-player"，告诉SpringMVC去渲染对应的视图。

### 请求参数：用户的表演需求 ###

在音乐会上，观众有时候需要提出一些建议或者表达一些特殊的需求。在Web开发中，用户通过请求参数来传递信息。SpringMVC提供了多种方式来获取请求参数。

#### 查询参数 ####

查询参数是附加在URL中的一部分，通常以`?`开头，多个参数之间使用`&`分隔。例如，访问`/music/play?song=Spring%20Symphony`，其中`song=Spring%20Symphony`就是一个查询参数。

在控制器方法中，可以通过`@RequestParam`注解来获取查询参数的值。

@Controller
    @RequestMapping("/music")
    public class MusicController {
        
    
        @GetMapping("/play")
        public String playMusic(@RequestParam(name = "song", defaultValue = "No Song") String song) {
        
            // 处理播放音乐的请求
            System.out.println("Playing: " + song);
            return "music-player";
        }
    }

在这个例子中，`playMusic`方法的参数中使用了`@RequestParam(name = "song", defaultValue = "No Song")`注解，表示从请求中获取名为"song"的查询参数，如果没有传递则使用默认值"No Song"。当用户访问`/music/play?song=Spring%20Symphony`时，将输出"Playing: Spring Symphony"。

#### 路径变量 ####

有时候，用户需要在路径中传递参数，而不是在查询参数中。这时可以使用路径变量。

@Controller
    @RequestMapping("/music")
    public class MusicController {
        
    
        @GetMapping("/play/{song}")
        public String playMusic(@PathVariable String song) {
        
            // 处理播放音乐的请求
            System.out.println("Playing: " + song);
            return "music-player";
        }
    }

在这个例子中，`playMusic`方法的参数中使用了`@PathVariable`注解，表示从路径中获取变量值。当用户访问`/music/play/Spring%20Symphony`时，将输出"Playing: Spring Symphony"。

### 请求体：用户的深层需求 ###

在某些情况下，用户需要通过请求体来传递更复杂的数据，比如JSON格式的数据。SpringMVC支持通过`@RequestBody`注解来获取请求体中的数据。

@RestController
    @RequestMapping("/api")
    public class ApiController {
        
    
        @PostMapping("/submitFeedback")
        public String submitFeedback(@RequestBody Map<String, String> feedback) {
        
            // 处理用户反馈的请求
            System.out.println("Received feedback: " + feedback);
            return "Feedback received!";
        }
    }

在这个例子中，`submitFeedback`方法的参数中使用了`@RequestBody`注解，表示从请求体中获取数据。当用户发送POST请求到`/api/submitFeedback`时，请求体中的JSON数据将被解析为`Map<String, String>`，并输出"Received feedback: \{key=value\}"。

### 请求头：用户的特殊要求 ###

在某些场景下，用户可能通过请求头传递一些特殊的要求，比如认证信息。SpringMVC提供了`@RequestHeader`注解来获取请求头中的信息。

@RestController
    @RequestMapping("/api")
    public class ApiController {
        
    
        @GetMapping("/getAuthToken")
        public String getAuthToken(@RequestHeader(name = "Authorization") String authToken) {
        
            // 处理获取认证令牌的请求
            System.out.println("Received Auth Token: " + authToken);
            return "Auth Token received!";
        }
    }

在这个例子中，`getAuthToken`方法的参数中使用了`@RequestHeader(name = "Authorization")`注解，表示从请求头中获取名为"Authorization"的信息。当用户发送GET请求到`/api/getAuthToken`时，请求头中的"Authorization"信息将被获取，并输出"Received Auth Token: \{authToken\}"。

### 请求方法：用户的行为指南 ###

HTTP协议定义了多种请求方法，常见的有GET、POST、PUT、DELETE等。SpringMVC通过`@RequestMapping`注解来指定控制器方法处理的请求方法。

@Controller
    @RequestMapping("/music")
    public class MusicController {
        
    
        @GetMapping("/play")
        public String playMusic() {
        
            // 处理播放音乐的GET请求
            return "music-player";
        }
    
        @PostMapping("/addFavorite")
        public String addFavorite() {
        
            // 处理添加到收藏的POST请求
            return "favorite-added";
        }
    }

在这个例子中，`playMusic`方法处理的是`/music/play`路径的GET请求，而`addFavorite`方法处理的是`/music/addFavorite`路径的POST请求。通过`@GetMapping`和`@PostMapping`注解，可以分别指定GET和POST请求的处理方法。

### 请求参数验证：用户的合法要求 ###

为了确保接收到的数据是合法的，SpringMVC提供了数据验证的机制。通过`@Valid`和`BindingResult`实现对请求参数的验证。

@RestController
    @RequestMapping("/api")
    public class ApiController {
        
    
        @PostMapping("/register")
        public String registerUser(@Valid @RequestBody User user, BindingResult bindingResult) {
        
            if (bindingResult.hasErrors()) {
        
                // 处理验证失败的情况
                return "Registration failed. Please check your data.";
            }
            // 处理用户注册的请求
            System.out.println("User registered: " + user);
            return "Registration successful!";
        }
    }

在这个例子中，`registerUser`方法接收一个`@Valid`注解的`User`对象，表示需要对其进行数据验证。`BindingResult`用于接收验证的结果。如果数据验证失败，将返回"Registration failed. Please check your data.“；如果验证成功，将输出"User registered: \{user\}”。

### 请求转发和重定向：用户的导演要求 ###

有时候，用户的需求可能需要将请求转发到另一个控制器方法或者重定向到另一个URL。SpringMVC提供了`forward:`和`redirect:`前缀来实现这两种需求。

@Controller
    @RequestMapping("/director")
    public class DirectorController {
        
    
        @GetMapping("/forwardToPlay")
        public String forwardToPlay() {
        
            // 请求转发到/music/play
            return "forward:/music/play";
        }
    
        @GetMapping("/redirectToHome")
        public String redirectToHome() {
        
            // 重定向到/home
            return "redirect:/home";
        }
    }

在这个例子中，`forwardToPlay`方法使用`return "forward:/music/play";`将请求转发到`/music/play`；而`redirectToHome`方法使用`return "redirect:/home";`将请求重定向到`/home`。

### 文件上传：用户的创意表达 ###

有时候，用户可能需要通过文件上传来表达更多的创意。SpringMVC通过`@RequestParam`注解和`MultipartFile`类来支持文件上传。

@Controller
    @RequestMapping("/creative")
    public class CreativeController {
        
    
        @PostMapping("/uploadFile")
        public String uploadFile(@RequestParam("file") MultipartFile file) {
        
            // 处理文件上传的请求
            System.out.println("Received file: " + file.getOriginalFilename());
            return "file-uploaded";
        }
    }

在这个例子中，`uploadFile`方法接收一个名为"file"的文件，并通过`MultipartFile`类来处理。当用户通过表单上传文件时，请求将被映射到`/creative/uploadFile`，文件将被处理并输出"Received file: \{filename\}"。

### 拦截器：用户的安保官员 ###

有时候，我们需要在请求处理前或处理后执行一些额外的逻辑，比如身份验证、日志记录等。这时候，可以使用拦截器。

public class AuthenticationInterceptor implements HandlerInterceptor {
        
    
        @Override
        public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        
            // 在请求处理前执行身份验证逻辑
            String authToken = request.getHeader("Authorization");
            if (authToken == null || !authToken.equals("ValidToken")) {
        
                response.sendError(HttpServletResponse.SC_UNAUTHORIZED, "Invalid authorization token.");
                return false;
            }
            return true;
        }
    
        // 其他拦截器方法可以根据需求实现
    }

在这个例子中，`AuthenticationInterceptor`实现了`HandlerInterceptor`接口，其中的`preHandle`方法用于在请求处理前执行身份验证逻辑。如果身份验证失败，将返回HTTP 401 Unauthorized响应。

<mvc:interceptors>
        <mvc:interceptor>
            <mvc:mapping path="/secure/**" />
            <bean class="com.example.interceptor.AuthenticationInterceptor" />
        </mvc:interceptor>
    </mvc:interceptors>

在`spring-mvc.xml`中配置拦截器，表示只对路径为"/secure/\*\*"的请求进行拦截，使用`AuthenticationInterceptor`进行处理。

### 结语 ###

SpringMVC的请求处理，就如同一场充满激情的音乐会，通过控制器方法、请求参数、请求体、请求头、请求方法、请求参数验证、请求转发和重定向、文件上传、拦截器等组件，为开发者提供了丰富而灵活的请求处理方式。在这个美妙的开端中，每个组件都有其独特的角色，共同为Web开发的旅程奏响了动人的序曲。愿你在编写代码的过程中，能够更好地驾驭这些乐谱，创造出属于自己的编码之美。在请求的律动中，与SpringMVC一同起舞，开启一段充满创意的编程旅程。

<table> 
 <tbody> 
  <tr> 
   <td> <strong><font>作者信息</font></strong><br> <br> <font> 作者 ： 繁依Fanyi</font><br> <font>CSDN：</font> <a href="https://blog.csdn.net/qq_21484461?spm=1000.2115.3001.5343" rel="nofollow"><font>https://techfanyi.blog.csdn.net</font></a><br> <font>掘金：</font><a href="https://juejin.cn/user/4154386571867191" rel="nofollow"><font>https://juejin.cn/user/4154386571867191</font></a> </td> 
  </tr> 
 </tbody> 
</table>

[00284c26956d4b778c232f61e9bac424.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/6852f749e8c94a40a8140879939e71b5.png