【Spring 篇】SpringMVC的数据响应：编织美妙的返回乐章

在Web开发的舞台上，数据响应就如同一场美妙的音乐演奏，而SpringMVC作为这场音乐的指挥者，如何优雅地将数据传递给前端，引发了无尽的思考和探索。本篇博客将带你走进SpringMVC的数据响应世界，解开其中的奥秘，感受这场编织美妙的返回乐章。

起舞的ModelAndView

在SpringMVC中，ModelAndView是一个神奇的对象，它承载着控制器方法的返回值，将模型数据和视图信息一同传递给前端。让我们通过一个简单的例子来感受一下ModelAndView的魅力。

@Controller
@RequestMapping("/music")
public class MusicController {

    @GetMapping("/play")
    public ModelAndView playMusic() {
        ModelAndView modelAndView = new ModelAndView("music-player");
        modelAndView.addObject("song", "Spring Symphony");
        return modelAndView;
    }
}

在这个例子中，playMusic方法返回一个ModelAndView对象，其中指定了视图名为"music-player"，并通过addObject方法将音乐的信息传递给前端。接下来，我们需要在/WEB-INF/views目录下创建一个名为music-player.jsp的JSP页面，用于展示音乐信息。

<%@ page contentType="text/html;charset=UTF-8" language="java" %>


    


    
Now Playing: ${song}

在这个JSP页面中，${song}将会被替换为控制器传递过来的音乐信息。当用户访问/music/play时，将看到页面上显示着"Now Playing: Spring Symphony"的欢迎消息。

Model：数据的魔法师

在SpringMVC的数据传递中，Model起到了一个重要的角色，它是一个接口，代表了模型数据的容器。控制器方法的参数中使用Model，就可以向前端传递数据。

@Controller
@RequestMapping("/magician")
public class MagicianController {

    @GetMapping("/castSpell")
    public String castSpell(Model model) {
        model.addAttribute("magicWord", "Abracadabra!");
        return "magic-show";
    }
}

在这个例子中，castSpell方法的参数中使用了Model，通过addAttribute方法将"magicWord"属性和对应的值传递给前端。在/WEB-INF/views目录下创建一个名为magic-show.jsp的JSP页面，用于展示魔法词语。

<%@ page contentType="text/html;charset=UTF-8" language="java" %>


    


    
Behold the magic: ${magicWord}

当用户访问/magician/castSpell时，页面将显示"Behold the magic: Abracadabra!"。

响应JSON：数据的轻盈旋律

除了传递HTML页面，SpringMVC还能轻松应对前后端分离的场景，以JSON的形式返回数据。JSON，即JavaScript Object Notation，是一种轻量级的数据交换格式，易于阅读和编写，也易于机器解析和生成。

@RestController
@RequestMapping("/api")
public class ApiController {

    @GetMapping("/getSong")
    public Map<String, String> getSong() {
        Map<String, String> songMap = new HashMap<>();
        songMap.put("songName", "Spring Serenade");
        return songMap;
    }
}

在这个例子中，ApiController使用了@RestController注解，表示这是一个RESTful风格的控制器，专门用于返回数据。getSong方法返回一个Map，其中包含了歌曲的信息。当用户访问/api/getSong时，将得到一个JSON格式的响应：

{
  "songName": "Spring Serenade"
}

响应状态码：音符的情感色彩

有时候，我们不仅需要返回数据，还需要传达一些特定的情感或状态信息。在HTTP协议中，状态码是一种常用的传递方式，SpringMVC也提供了简便的方式来设置响应状态码。

@RestController
@RequestMapping("/emotion")
public class EmotionController {

    @GetMapping("/express")
    public ResponseEntity<String> expressEmotion() {
        HttpHeaders headers = new HttpHeaders();
        headers.add("Express-Color", "Spring Green");
        return new ResponseEntity<>("Expressing happiness!", headers, HttpStatus.OK);
    }
}

在这个例子中，EmotionController返回了一个ResponseEntity对象，其中包含了响应的主体内容、头信息和状态码。用户访问/emotion/express时，将得到一个带有自定义头信息的HTTP 200 OK响应，响应内容为"Expressing happiness!"。

异常处理：和弦的优雅回响

在音乐的世界里，有时会出现一些不可避免的小插曲，而在编写Web应用程序时，处理异常也是不可或缺的一环。SpringMVC通过@ExceptionHandler注解提供了简单而强大的异常处理机制。

@Controller
@RequestMapping("/orchestra")
public class OrchestraController {

    @GetMapping("/playConcert")
    public String playConcert() {
        // 模拟异常
        throw new ConcertFailedException("Concert failed due to technical issues.");
    }

    @ExceptionHandler(ConcertFailedException.class)
    public ModelAndView handleConcertFailedException(ConcertFailedException ex) {
        ModelAndView modelAndView = new ModelAndView("concert-failed");
        modelAndView.addObject("errorMessage", ex.getMessage());
        return modelAndView;
    }
}

在这个例子中，playConcert方法模拟了一个音乐会中的异常，抛出了一个ConcertFailedException。而在同一个控制器中，通过@ExceptionHandler注解的handleConcertFailedException方法，对特定的异常进行处理。创建一个名为concert-failed.jsp的JSP页面，用于展示音乐会失败的信息。

<%@ page contentType="text/html;charset=UTF-8" language="java" %>


    


    
Oh no! The concert failed.
    
Error Message: ${errorMessage}

当用户访问/orchestra/playConcert时，将得到一个页面，显示"Oh no! The concert failed."，并展示详细的错误信息。

静态资源：背景音乐的魔法

在Web应用中，除了动态生成的数据，还有一些静态资源，比如图片、样式表和JavaScript文件等。SpringMVC通过ResourceHandlerRegistry提供了方便的静态资源处理。

@Configuration
@EnableWebMvc
public class WebConfig implements WebMvcConfigurer {

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/music-bg.mp3")
                .addResourceLocations("classpath:/static/music/")
                .setCachePeriod(3600)
                .resourceChain(true)
                .addResolver(new GzipResourceResolver())
                .addResolver(new PathResourceResolver());
    }
}

在这个例子中，通过addResourceHandlers方法配置了静态资源的处理，当用户访问/music-bg.mp3时，将从classpath中的/static/music/目录下寻找对应的音乐文件。这样，我们就能够在Web应用中添加一些背景音乐了。

跨域请求处理：音乐的跨界演奏

在现代Web开发中，跨域请求已成为常态。SpringMVC通过@CrossOrigin注解提供了简单的跨域请求处理方式。

@RestController
@RequestMapping("/cross-domain")
public class CrossDomainController {

    @GetMapping("/playMusic")
    @CrossOrigin(origins = "http://allowed-domain.com")
    public Map<String, String> playMusic() {
        Map<String, String> songMap = new HashMap<>();
        songMap.put("songName", "Cross-domain Symphony");
        return songMap;
    }
}

在这个例子中，通过@CrossOrigin注解，设置了允许访问的域名为"http://allowed-domain.com"。当该控制器方法被访问时，只有来自该域名的请求将被允许。

结语

SpringMVC的数据响应，就如同一场千变万化的音乐会，通过ModelAndView、Model、JSON、响应状态码、异常处理、静态资源处理、跨域请求处理等组件，为开发者提供了丰富而灵活的数据传递方式。在这个美妙的乐章中，每个组件都有其独特的声音，共同奏响了Web开发的交响曲。愿你在编写代码的过程中，能够更好地驾驭这些乐谱，创造出属于自己的音乐之美。在代码的海洋里，与数据的旋律共舞，愉悦前行。

作者信息 作者 ： 繁依Fanyi CSDN： https://techfanyi.blog.csdn.net 掘金：https://juejin.cn/user/4154386571867191