MappingJackson2JsonView 优化RESTful API的JSON响应

最新推荐文章于 2024-07-01 11:52:52 发布

Solomon_肖哥弹架构

最新推荐文章于 2024-07-01 11:52:52 发布

阅读量365

点赞数 5

文章标签： restful json 后端 spring springboot mvc

本文链接：https://blog.csdn.net/alises1314/article/details/140097050

版权

肖哥弹架构 跟大家“弹弹” MappingJackson2JsonView 业务使用与功能设计
欢迎点赞，点赞，点赞。

关注本人的公众号Solomon肖哥弹架构获取更多精彩内容

MappingJackson2JsonView 优化JSON格式的RESTful API响应。这种技术可以提高JSON数据的可读性和维护性，同时支持复杂的数据结构。

类结构设计

业务说明：

一个电子商务平台的商品推荐功能，该功能需要根据用户的行为和偏好向他们推荐商品。需要确保返回的JSON数据,简洁且准确，而且易于前端处理和展示。

核心技术点：

JSON数据格式：一种轻量级的数据交换格式，易于人阅读和编写，同时也易于机器解析和生成。
MappingJackson2JsonView：Spring MVC中的一个视图，用于将模型数据转换为JSON格式的响应。
Jackson 2：一个Java库，用于将对象序列化为JSON格式，以及将JSON反序列化为对象。

工作流程图：

前端内容：

前端开发者将使用AJAX或其他HTTP客户端技术来请求API，并处理返回的JSON数据。

请求与响应数据：

请求：

    GET /api/recommendations?userId=123
    Accept: application/json

响应：

    {
      "recommendations": [
        {
          "productId": "456",
          "name": "Smartphone X",
          "description": "Latest model with advanced features.",
          "price": 999.99
        },
        {
          "productId": "789",
          "name": "Wireless Headphones",
          "description": "High-quality sound for music lovers.",
          "price": 199.99
        }
      ]
    }

核心代码：

1. Spring MVC配置（Java配置方式）：

    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.web.servlet.View;
    import org.springframework.web.servlet.view.json.MappingJackson2JsonView;

    @Configuration
    public class WebConfig {

        @Bean
        public View jsonView() {
            return new MappingJackson2JsonView();
        }
    }

2. 商品推荐模型类（Recommendation.java）：

    import java.util.List;

    public class Recommendation {
        private String productId;
        private String name;
        private String description;
        private double price;

        // 标准getter和setter方法
    }

    public class RecommendationsResponse {
        private List<Recommendation> recommendations;

        // 标准getter和setter方法
    }

3. 控制器：

    import org.springframework.stereotype.Controller;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RequestParam;
    import org.springframework.web.servlet.ModelAndView;

    @Controller
    public class RecommendationController {

        @GetMapping("/api/recommendations")
        public ModelAndView getRecommendations(@RequestParam("userId") String userId) {
            RecommendationsResponse response = recommendationService.getRecommendationsByUserId(userId); 
            //自定义指定视图
            ModelAndView modelAndView = new ModelAndView(new MappingJackson2JsonView());
            modelAndView.addObject("recommendations", response.getRecommendations());
            return modelAndView;
        }
    }

4. 服务层（RecommendationService.java）：

    public class RecommendationService {

        public RecommendationsResponse getRecommendationsByUserId(String userId) {
            // 根据用户ID获取推荐商品列表
            return new RecommendationsResponse(); // 返回推荐响应对象
        }
    }