【JavaEE进阶】 关于Spring MVC 响应

本文涉及的产品
全局流量管理 GTM,标准版 1个月
云解析 DNS,旗舰版 1个月
公共DNS(含HTTPDNS解析),每月1000万次HTTP解析
简介: 【JavaEE进阶】 关于Spring MVC 响应

【JavaEE进阶】 关于Spring MVC 响应

 

Spring MVC 是 Spring Framework 的一个模块,旨在为开发基于 Java 的 Web 应用程序提供一个简单而强大的框架。它基于 Model-View-Controller (MVC) 设计模式,分离了应用程序的各个组件,提供了高内聚、低耦合的架构。

 

本文将深入探讨 Spring MVC 中的响应机制,包括如何处理 HTTP 响应、如何使用不同的视图解析器,以及如何返回 JSON 或 XML 格式的数据。

 

一、Spring MVC 中的基本响应机制

 

1.1 @Controller 和 @ResponseBody

 

在 Spring MVC 中,@Controller 注解用于定义控制器类,它负责处理 HTTP 请求并返回响应。@ResponseBody 注解用于将控制器方法的返回值直接写入 HTTP 响应体中。

 

```java
import org.springframework.web.bind.annotation.*;
 
@RestController
public class HelloController {
 
    @RequestMapping("/hello")
    @ResponseBody
    public String hello() {
        return "Hello, Spring MVC!";
    }
}
```

 

在这个例子中,`hello` 方法返回一个字符串,该字符串直接写入 HTTP 响应体中。

 

1.2 @RestController

 

@RestController 是 @Controller 和 @ResponseBody 的组合注解,常用于返回 JSON 或 XML 格式的数据。

 

```java
import org.springframework.web.bind.annotation.*;
 
@RestController
public class UserController {
 
    @GetMapping("/user")
    public User getUser() {
        return new User("John", 30);
    }
}
```

 

在这个例子中,`getUser` 方法返回一个 `User` 对象,该对象将被自动转换为 JSON 格式并写入 HTTP 响应体中。

 

1.3 返回视图

 

在 Spring MVC 中,可以返回视图名,并通过视图解析器来解析视图名,从而渲染 HTML 页面。

 

```java
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;
 
@Controller
public class PageController {
 
    @RequestMapping("/welcome")
    public ModelAndView welcome() {
        ModelAndView modelAndView = new ModelAndView();
        modelAndView.setViewName("welcome");
        modelAndView.addObject("message", "Welcome to Spring MVC!");
        return modelAndView;
    }
}
```

 

在这个例子中,`welcome` 方法返回一个 `ModelAndView` 对象,其中包含视图名 `welcome` 和模型数据 `message`。视图解析器将根据视图名找到相应的视图模板并渲染 HTML 页面。

 

二、视图解析器

 

2.1 InternalResourceViewResolver

 

InternalResourceViewResolver 是 Spring MVC 中最常用的视图解析器之一,通常用于解析 JSP 视图。

 

```xml
<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
    <property name="prefix" value="/WEB-INF/views/" />
    <property name="suffix" value=".jsp" />
</bean>
```

 

在这个配置中,视图名 `welcome` 将被解析为 `/WEB-INF/views/welcome.jsp`。

 

2.2 ThymeleafViewResolver

 

Thymeleaf 是一种现代的服务器端 Java 模板引擎,通常与 Spring MVC 一起使用。

 

```xml
<bean id="viewResolver" class="org.thymeleaf.spring5.view.ThymeleafViewResolver">
    <property name="templateEngine" ref="templateEngine" />
</bean>
```

 

在这个配置中,视图名 `welcome` 将被解析为 `welcome.html`,并通过 Thymeleaf 渲染。

 

三、返回 JSON 和 XML 数据

 

3.1 使用 @RestController 和 Jackson

 

Spring MVC 通过集成 Jackson 来支持 JSON 数据的自动转换。只需在类路径中包含 Jackson 依赖即可。

 

```xml
<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
</dependency>
```

 

控制器方法返回 Java 对象时,Spring MVC 会自动将其转换为 JSON 格式。

 

3.2 自定义 JSON 转换

 

可以使用 `@JsonProperty` 注解来自定义 JSON 字段名,或通过 `ObjectMapper` 进行更复杂的配置。

 

```java
import com.fasterxml.jackson.annotation.JsonProperty;
 
public class User {
 
    @JsonProperty("username")
    private String name;
    private int age;
 
    // getters and setters
}
```

 

3.3 返回 XML 数据

 

除了 JSON,Spring MVC 还支持将对象转换为 XML 格式。只需在类路径中包含 Jackson XML 依赖即可。

 

```xml
<dependency>
    <groupId>com.fasterxml.jackson.dataformat</groupId>
    <artifactId>jackson-dataformat-xml</artifactId>
</dependency>
```

 

然后在控制器方法中返回对象,Spring MVC 会自动将其转换为 XML 格式。

 

```java
import org.springframework.web.bind.annotation.*;
import com.fasterxml.jackson.dataformat.xml.annotation.*;
 
@RestController
public class UserController {
 
    @GetMapping(value = "/user", produces = "application/xml")
    public User getUser() {
        return new User("John", 30);
    }
}

```

 

四、示例项目代码

 

以下是一个完整的 Spring Boot 项目示例,展示了如何配置和使用 Spring MVC 响应机制。

 

4.1 Maven 依赖

 

```xml
<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>com.fasterxml.jackson.core</groupId>
        <artifactId>jackson-databind</artifactId>
    </dependency>
    <dependency>
        <groupId>com.fasterxml.jackson.dataformat</groupId>
        <artifactId>jackson-dataformat-xml</artifactId>
    </dependency>
    <dependency>
        <groupId>org.thymeleaf</groupId>
        <artifactId>thymeleaf-spring5</artifactId>
    </dependency>
</dependencies>
```

 

4.2 Spring Boot 主应用程序

 

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

 

4.3 控制器类

 

```java
import org.springframework.web.bind.annotation.*;
 
@RestController
public class UserController {
 
    @GetMapping("/user")
    public User getUser() {
        return new User("John", 30);
    }
 
    @GetMapping(value = "/user/xml", produces = "application/xml")
    public User getUserXml() {
        return new User("John", 30);
    }
}
```

 

4.4 视图控制器

 

```java
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;
 
@Controller
public class PageController {
 
    @RequestMapping("/welcome")
    public ModelAndView welcome() {
        ModelAndView modelAndView = new ModelAndView();
        modelAndView.setViewName("welcome");
        modelAndView.addObject("message", "Welcome to Spring MVC!");
        return modelAndView;
    }
}
```

 

4.5 配置视图解析器

 

```java
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.thymeleaf.spring5.SpringTemplateEngine;
import org.thymeleaf.spring5.templateresolver.SpringResourceTemplateResolver;
import org.thymeleaf.spring5.view.ThymeleafViewResolver;
 
@Configuration
public class ThymeleafConfig {
 
    @Bean
    public SpringResourceTemplateResolver templateResolver() {
        SpringResourceTemplateResolver templateResolver = new SpringResourceTemplateResolver();
        templateResolver.setPrefix("classpath:/templates/");
        templateResolver.setSuffix(".html");
        templateResolver.setTemplateMode("HTML5");
        return templateResolver;
    }
 
    @Bean
    public SpringTemplateEngine templateEngine() {
        SpringTemplateEngine templateEngine = new SpringTemplateEngine();
        templateEngine.setTemplateResolver(templateResolver());
        return templateEngine;
    }
 
    @Bean
    public ThymeleafViewResolver viewResolver() {
        ThymeleafViewResolver viewResolver = new ThymeleafViewResolver();
        viewResolver.setTemplateEngine(templateEngine());
        return viewResolver;
    }
}
```

 

4.6 Thymeleaf 视图模板

 

创建一个 `welcome.html` 文件,放在 `src/main/resources/templates/` 目录下。

 

```html
<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <title>Welcome</title>
</head>
<body>
    <h1 th:text="${message}">Welcome to Spring MVC!</h1>
</body>
</html>
```

 

结论

 

Spring MVC 提供了强大的响应处理机制,通过使用注解和配置,可以方便地实现不同类型的响应,如视图响应、JSON 数据响应和 XML 数据响应。通过对视图解析器的配置,可以灵活地选择和使用不同的视图技术,如 JSP 和 Thymeleaf。希望通过本文的介绍,能够帮助您更好地理解和应用 Spring MVC 的响应机制,提高开发效率和应用性能。

目录
相关文章
|
23天前
|
JSON 前端开发 Java
spring mvc Rest风格
spring mvc Rest风格
18 0
|
8天前
|
前端开发 Java 应用服务中间件
我以为我对Spring MVC很了解,直到我遇到了...
所有人都知道Spring MVC是是开发的,却鲜有人知道Spring MVC的理论基础来自于1978 年提出MVC模式的一个老头子,他就是Trygve Mikkjel Heyerdahl Reenskaug,挪威计算机科学家,名誉教授。Trygve Reenskaug的MVC架构思想早期用于图形用户界面(GUI) 的软件设计,他对MVC是这样解释的。MVC 被认为是解决用户控制大型复杂数据集问题的通用解决方案。最困难的部分是为不同的架构组件想出好的名字。模型-视图-编辑器是第一个。
我以为我对Spring MVC很了解,直到我遇到了...
|
17天前
|
前端开发 Java Spring
Spring MVC中使用ModelAndView传递数据
Spring MVC中使用ModelAndView传递数据
|
24天前
|
安全 前端开发 Java
挑战5分钟内基于Springboot+SpringMVC+Mybatis-plus快速构建web后端三层架构
挑战5分钟内基于Springboot+SpringMVC+Mybatis-plus快速构建web后端三层架构
26 1
|
27天前
|
设计模式 前端开发 Java
【Spring MVC】快速学习使用Spring MVC的注解及三层架构
【Spring MVC】快速学习使用Spring MVC的注解及三层架构
22 1
|
10天前
|
XML 前端开发 Java
Spring Boot与Spring MVC的区别和联系
Spring Boot与Spring MVC的区别和联系
序-Servlet和SpringMVC的联系和区别-配置路径先想好使用的使用的方法,然后匹配的需要的技术
序-Servlet和SpringMVC的联系和区别-配置路径先想好使用的使用的方法,然后匹配的需要的技术
|
21天前
|
前端开发
Spring-MVC的数据响应-19
Spring-MVC的数据响应-19
|
21天前
|
JSON 前端开发 数据格式
SpringMVC的数据响应-直接回写json字符串
SpringMVC的数据响应-直接回写json字符串