SpringBoot中的内容协商器图解

背景

使用了restful的小伙伴对于导出这些需求本能就是拒绝的~破坏了restful的url的一致性【严格矫正 不是http json就是restful 很多小伙伴都会吧暴露出一个json就直接称为restful 】

正如上文的代码生成器 我们会批量生成一堆代码 其中绝大部分都是RestController

  public abstract class AbstractRestController<V extends Vo, S extends So, PK extends Serializable> {
    protected Class<V> voClazz;
    @Autowired
    private Service<V, S, PK> service;
    public AbstractRestController() {
      TypeToken<V> voType = new TypeToken<V>(getClass()) {
      };
      voClazz = (Class<V>) voType.getRawType();
    }
    @PostMapping()
    @ApiOperation(value = "新建实体", notes = "")
    public Result add(@RequestBody V vo) {
      service.saveSelective(vo);
      return ResultGenerator.genSuccessResult();
    }
    @DeleteMapping("/{id}")
    @ApiOperation(value = "删除实体", notes = "")
    public Result delete(@PathVariable PK id) {
      service.deleteById(id);
      return ResultGenerator.genSuccessResult();
    }
    @PutMapping
    @ApiOperation(value = "更新实体", notes = "")
    public Result update(@RequestBody V vo) {
      service.updateByPrimaryKeySelective(vo);
      return ResultGenerator.genSuccessResult();
    }
    @GetMapping
    @ApiOperation(value = "获取实体列表", notes = "")
    public Result list(S so) {
      PageHelper.startPage(so.getCurrentPage(), so.getPageSize());
      List<V> list = service.findAll();
      PageInfo pageInfo = new PageInfo(list);
      excelExportParam();
      return ResultGenerator.genSuccessResult(pageInfo);
    }
    protected void excelExportParam() {
      ExportParams ep = new ExportParams(null, "数据");
      ExcelExportParam<V> param = new ExcelExportParam<>();
      param.setClazz(voClazz);
      param.setExcelExport(ExcelExport.NormalExcel);
      param.setExportParams(ep);
      param.setFileName("文件.xls");
      F6Static.setExcelExportParam(param);
    }
    @GetMapping("/{id}")
    @ApiOperation(value = "获取单个实体", notes = "")
    public Result detail(@PathVariable PK id) {
      V vo = service.findById(id);
      return ResultGenerator.genSuccessResult(vo);
    }
    @DeleteMapping("/batch")
    @ApiOperation(value = "批量删除实体", notes = "")
    public Result batchDelete(@RequestParam String ids) {
      service.deleteByIds(ids);
      return ResultGenerator.genSuccessResult();
    }
    @GetMapping("/batch")
    @ApiOperation(value = "批量获取实体", notes = "")
    public Result batchDetail(@RequestParam String ids) {
      List<V> vos = service.findByIds(ids);
      return ResultGenerator.genSuccessResult(vos);
    }
    @PostMapping("/batch")
    @ApiOperation(value = "批量新建实体", notes = "")
    public Result add(@RequestBody List<V> vos) {
      service.save(vos);
      return ResultGenerator.genSuccessResult();
    }
    @GetMapping("/count")
    @ApiOperation(value = "获取实体数目", notes = "")
    public Result count(@RequestBody V v) {
      int count = service.selectCount(v);
      return ResultGenerator.genSuccessResult(count);
    }

那么导出如何做呢?【其实可以理解成导出就是数据的展示 不过此时结果不是json而已】

抛出一个问题那么登录登出呢?传统的方案都是login logout 那么换成restful资源的思路是啥呢?

提示: 登录就是session的新建 登出就是session的删除

实现

基于上述思路 我们自然就想到了那么我们只需要对同一个url返回多种结果不就OK了?【pdf一个版本 json一个版本 xml一个版本 xls一个版本】

bingo!这个是内容协商器的由来

内容协商器并不是Spring创造出来的 事实上这个从http头里面也能看出

1.比如给英语客户返回英语页面 过于客户返回汉语页面

HTTP 协议中定义了质量值(简称 q 值),允许客户端为每种偏好类别列出多种选项,并为每种偏好选项关联一个优先次序。

Accept-Language: en;q=0.5, fr;q=0.0, nl;q=1.0, tr;q=0.0

其中 q 值的范围从 0.0 ~ 1.0(0.0 是优先级最低的,而 1.0 是优先级最高的)。

注意,偏好的排列顺序并不重要,只有与偏好相关的 q 值才是重要的

2.那么还有其他的一些参数 比如 accept-header

通常是先内容协商器有如下几种方案

1.使用Accept header:

这一种为教科书中通常描述的一种,理想中这种方式也是最好的,但如果你的资源要给用户直接通过浏览器访问(即html展现),那么由于浏览器的差异,发送上来的Accept Header头将是不一样的. 将导致服务器不知要返回什么格式的数据给你. 下面是浏览器的Accept Header

 chrome:
    Accept:application/xml,application/xhtml+xml,textml;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
    firefox:
    Accept:text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
    IE8:
    Accept:image/gif, image/jpeg, image/pjpeg, image/pjpeg, application/x-shockwave-flash, application/x-silverlight, application/x-ms-application, application/x-ms-xbap, application/vnd.ms-xpsdocument, application/xaml+xml, */*  

2.使用扩展名

丧失了同一url多种展现的方式,但现在这种在实际环境中是使用最多的.因为更加符合程序员的审美观.

比如/user.json /user.xls /user.xml

使用参数 现在很多open API是使用这种方式,比如淘宝

但是对于不同浏览器可能accept-header并不是特别统一 因此许多实现选择了2 3两种方案

我们在Spring中采用上述两种方案

首先配置内容协商器

代码

@Bean
  public ViewResolver contentNegotiatingViewResolver(
      ContentNegotiationManager manager) {
    // Define the view resolvers
    ViewResolver beanNameViewResolver = new BeanNameViewResolver();
    List<ViewResolver> resolvers = Lists.newArrayList(beanNameViewResolver);
    ContentNegotiatingViewResolver resolver = new ContentNegotiatingViewResolver();
    resolver.setViewResolvers(resolvers);
    resolver.setContentNegotiationManager(manager);
    return resolver;
  }
  @Override
  public void configureContentNegotiation(ContentNegotiationConfigurer configurer) {
    configurer.favorPathExtension(true)
        .useJaf(false)
        .favorParameter(true)
        .parameterName("format")
        .ignoreAcceptHeader(true)
        .defaultContentType(MediaType.APPLICATION_JSON)
        .mediaType("json", MediaType.APPLICATION_JSON)
        .mediaType("xls", EXCEL_MEDIA_TYPE);
  }

创建对应的转换器

  private HttpMessageConverter<Object> createExcelHttpMessageConverter() {
    ExcelHttpMessageConverter excelHttpMessageConverter = new ExcelHttpMessageConverter();
    return excelHttpMessageConverter;
  }

直接使用easy-poi导出数据

  /*
   * Copyright (c) 2017. Lorem ipsum dolor sit amet, consectetur adipiscing elit.
   * Morbi non lorem porttitor neque feugiat blandit. Ut vitae ipsum eget quam lacinia accumsan.
   * Etiam sed turpis ac ipsum condimentum fringilla. Maecenas magna.
   * Proin dapibus sapien vel ante. Aliquam erat volutpat. Pellentesque sagittis ligula eget metus.
   * Vestibulum commodo. Ut rhoncus gravida arcu.
   */
  package com.f6car.base.web.converter;
  import cn.afterturn.easypoi.excel.ExcelExportUtil;
  import com.f6car.base.common.Result;
  import com.f6car.base.core.ExcelExport;
  import com.f6car.base.core.ExcelExportParam;
  import com.github.pagehelper.PageInfo;
  import com.google.common.collect.Lists;
  import org.apache.poi.ss.usermodel.Workbook;
  import org.springframework.http.HttpHeaders;
  import org.springframework.http.HttpInputMessage;
  import org.springframework.http.HttpOutputMessage;
  import org.springframework.http.MediaType;
  import org.springframework.http.converter.AbstractHttpMessageConverter;
  import org.springframework.http.converter.GenericHttpMessageConverter;
  import org.springframework.http.converter.HttpMessageNotReadableException;
  import org.springframework.http.converter.HttpMessageNotWritableException;
  import java.io.IOException;
  import java.lang.reflect.Type;
  import java.net.URLEncoder;
  import java.util.Collection;
  import java.util.Collections;
  import java.util.Map;
  import static com.f6car.base.core.F6Static.getExcelExportParam;
  /**
   * @author qixiaobo
   */
  public class ExcelHttpMessageConverter extends AbstractHttpMessageConverter<Object>
      implements GenericHttpMessageConverter<Object> {
    public static final MediaType EXCEL_MEDIA_TYPE = new MediaType("application", "vnd.ms-excel");
    public ExcelHttpMessageConverter() {
      super(EXCEL_MEDIA_TYPE);
    }
    @Override
    protected boolean supports(Class<?> clazz) {
      return false;
    }
    @Override
    protected Object readInternal(Class<?> clazz, HttpInputMessage inputMessage) throws IOException, HttpMessageNotReadableException {
      return null;
    }
    @Override
    protected void writeInternal(Object o, HttpOutputMessage outputMessage) throws IOException, HttpMessageNotWritableException {
      HttpHeaders headers = outputMessage.getHeaders();
      Collection data = getActualData((Result) o);
      ExcelExportParam excelExportParam = getExcelExportParam();
      Workbook workbook;
      switch (excelExportParam.getExcelExport()) {
        case NormalExcel:
          workbook = ExcelExportUtil.exportExcel(
              excelExportParam.getExportParams(),
              (Class<?>) excelExportParam.getClazz(),
              (Collection<?>) data);
          break;
        case MapExcel:
          workbook = ExcelExportUtil.exportExcel(
              excelExportParam.getExportParams(),
              excelExportParam.getExcelExportEntities(),
              (Collection<? extends Map<?, ?>>) data);
          break;
        case BigExcel:
        case MapExcelGraph:
        case PDFTemplate:
        case TemplateExcel:
        case TemplateWord:
        default:
          throw new RuntimeException();
      }
      if (workbook != null) {
        if (excelExportParam.getFileName() != null) {
          String codedFileName = URLEncoder.encode(excelExportParam.getFileName(), "UTF8");
          headers.setContentDispositionFormData("attachment", codedFileName);
        }
        workbook.write(outputMessage.getBody());
      }
    }
    private Collection getActualData(Result r) {
      if (r != null && r.getData() != null) {
        Object data = r.getData();
        if (data instanceof PageInfo) {
          return ((PageInfo) data).getList();
        } else if (!(data instanceof Collection)) {
          data = Lists.newArrayList(data);
        } else {
          return (Collection) data;
        }
      }
      return Collections.emptyList();
    }
    @Override
    public boolean canRead(Type type, Class<?> contextClass, MediaType mediaType) {
      //不支持excel
      return false;
    }
    @Override
    public Object read(Type type, Class<?> contextClass, HttpInputMessage inputMessage) throws IOException, HttpMessageNotReadableException {
      return null;
    }
    @Override
    public boolean canWrite(Type type, Class<?> clazz, MediaType mediaType) {
      return super.canWrite(mediaType) && clazz == Result.class && support();
    }
    private boolean support() {
      ExcelExportParam param = getExcelExportParam();
      if (param == null || param.getExcelExport() == null || param.getExportParams() == null) {
        return false;
      }
      if (param.getExcelExport() == ExcelExport.NormalExcel) {
        return true;
      } else {
        logger.warn(param.getExcelExport() + " not supprot now!");
        return false;
      }
    }
    @Override
    public void write(Object o, Type type, MediaType contentType, HttpOutputMessage outputMessage) throws IOException, HttpMessageNotWritableException {
      super.write(o, contentType, outputMessage);
    }
  }

暂时只是针对导出 因此在使用的时候如下

 @GetMapping
  @ApiOperation(value = "获取实体列表", notes = "")
  public Result list(S so) {
    PageHelper.startPage(so.getCurrentPage(), so.getPageSize());
    List<V> list = service.findAll();
    PageInfo pageInfo = new PageInfo(list);
    excelExportParam();
    return ResultGenerator.genSuccessResult(pageInfo);
  }
  protected void excelExportParam() {
    ExportParams ep = new ExportParams(null, "数据");
    ExcelExportParam<V> param = new ExcelExportParam<>();
    param.setClazz(voClazz);
    param.setExcelExport(ExcelExport.NormalExcel);
    param.setExportParams(ep);
    param.setFileName("文件.xls");
    F6Static.setExcelExportParam(param);
  }

当我们访问时如下

http://127.0.0.1:8079/zeus/user

 {
  "code": 200,
  "data": {
  "endRow": 10,
  "firstPage": 1,
  "hasNextPage": true,
  "hasPreviousPage": false,
  "isFirstPage": true,
  "isLastPage": false,
  "lastPage": 8,
  "list": [
  {
  "cellPhone": "13857445502",
  "idEmployee": 24201883434352650,
  "idOwnOrg": 23993199378825296,
  "idRole": 88,
  "idWxbStation": "332",
  "idWxbUser": "207",
  "isAdmin": 1,
  "isDel": 0,
  "isGuideOpen": 0,
  "limitMac": 0,
  "openid": "",
  "password": "96e79218965eb72c92a549dd5a330112",
  "pkId": 23993199378825296,
  "username": "lingweiqiche"
  },
  {
  "cellPhone": "",
  "idEmployee": 0,
  "idOwnOrg": 9999,
  "idRole": 4,
  "idWxbStation": "",
  "idWxbUser": "",
  "isAdmin": 0,
  "isDel": 0,
  "isGuideOpen": 0,
  "limitMac": 0,
  "openid": "",
  "password": "96e79218965eb72c92a549dd5a330112",
  "pkId": 24201883434356532,
  "username": "007"
  },
  {
  "cellPhone": "15715139000",
  "idEmployee": 24351585207523460,
  "idOwnOrg": 24201883434357600,
  "idRole": 89,
  "idWxbStation": "540",
  "idWxbUser": "298",
  "isAdmin": 1,
  "isDel": 0,
  "isGuideOpen": 0,
  "limitMac": 0,
  "openid": "",
  "password": "96e79218965eb72c92a549dd5a330112",
  "pkId": 24201883434357600,
  "username": "15715139000"
  },
  {
  "cellPhone": "",
  "idEmployee": 0,
  "idOwnOrg": 24201883434357600,
  "idRole": 216,
  "idWxbStation": "",
  "idWxbUser": "",
  "isAdmin": 0,
  "isDel": 0,
  "isGuideOpen": 0,
  "limitMac": 0,
  "openid": "",
  "password": "96e79218965eb72c92a549dd5a330112",
  "pkId": 24201883434357920,
  "username": "sunlingli"
  },
  {
  "cellPhone": "",
  "idEmployee": 24351585207425676,
  "idOwnOrg": 24201883434359384,
  "idRole": 90,
  "idWxbStation": "348",
  "idWxbUser": "227",
  "isAdmin": 1,
  "isDel": 0,
  "isGuideOpen": 0,
  "limitMac": 0,
  "openid": "opzUDs_v13WE500kxYMj6Xg_gFeE",
  "password": "96e79218965eb72c92a549dd5a330112",
  "pkId": 24201883434359388,
  "username": "15952920979"
  },
  {
  "cellPhone": "",
  "idEmployee": 0,
  "idOwnOrg": 24201883434359790,
  "idRole": 91,
  "idWxbStation": "315",
  "idWxbUser": "175",
  "isAdmin": 1,
  "isDel": 0,
  "isGuideOpen": 0,
  "limitMac": 0,
  "openid": "",
  "password": "96e79218965eb72c92a549dd5a330112",
  "pkId": 24201883434359790,
  "username": "13809056211"
  },
  {
  "cellPhone": "18903885585",
  "idEmployee": 24201883434366164,
  "idOwnOrg": 24201883434359890,
  "idRole": 92,
  "idWxbStation": "317",
  "idWxbUser": "178",
  "isAdmin": 1,
  "isDel": 0,
  "isGuideOpen": 0,
  "limitMac": 0,
  "openid": "",
  "password": "96e79218965eb72c92a549dd5a330112",
  "pkId": 24201883434359892,
  "username": "18903885585"
  },
  {
  "cellPhone": "",
  "idEmployee": 24351585207425668,
  "idOwnOrg": 24201883434359924,
  "idRole": 93,
  "idWxbStation": "318",
  "idWxbUser": "179",
  "isAdmin": 1,
  "isDel": 0,
  "isGuideOpen": 0,
  "limitMac": 0,
  "openid": "",
  "password": "96e79218965eb72c92a549dd5a330112",
  "pkId": 24201883434359930,
  "username": "13372299595"
  },
  {
  "cellPhone": "",
  "idEmployee": 0,
  "idOwnOrg": 24201883434360052,
  "idRole": 94,
  "idWxbStation": "321",
  "idWxbUser": "188",
  "isAdmin": 1,
  "isDel": 0,
  "isGuideOpen": 0,
  "limitMac": 0,
  "openid": "",
  "password": "96e79218965eb72c92a549dd5a330112",
  "pkId": 24201883434360052,
  "username": "15221250005"
  },
  {
  "cellPhone": "",
  "idEmployee": 0,
  "idOwnOrg": 24201883434360070,
  "idRole": 95,
  "idWxbStation": "325",
  "idWxbUser": "198",
  "isAdmin": 1,
  "isDel": 0,
  "isGuideOpen": 0,
  "limitMac": 0,
  "openid": "",
  "password": "96e79218965eb72c92a549dd5a330112",
  "pkId": 24201883434360070,
  "username": "13837251167"
  }
  ],
  "navigateFirstPage": 1,
  "navigateLastPage": 8,
  "navigatePages": 8,
  "navigatepageNums": [
  1,
  2,
  3,
  4,
  5,
  6,
  7,
  8
  ],
  "nextPage": 2,
  "orderBy": "",
  "pageNum": 1,
  "pageSize": 10,
  "pages": 102,
  "prePage": 0,
  "size": 10,
  "startRow": 1,
  "total": 1012
  },
  "message": "SUCCESS"
  }

当访问http://127.0.0.1:8079/zeus/user?format=xls 或者http://127.0.0.1:8079/zeus/user.xls

如下效果

由于这边的数据和查询有关 因此我们可以这样操作http://127.0.0.1:8079/zeus/user.xls?pageSize=1000 轻而易举实现了查询结果xls化!

总结

以上所述是小编给大家介绍的SpringBoot中的内容协商器图解,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对我们网站的支持!

(0)

相关推荐

  • SpringBoot获取yml和properties配置文件的内容

    (一)yml配置文件: pom.xml加入依赖: <!-- 支持 @ConfigurationProperties 注解 --> <!-- https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-configuration-processor --> <dependency> <groupId>org.springframework.boot</groupId>

  • SpringBoot中的内容协商器图解

    背景 使用了restful的小伙伴对于导出这些需求本能就是拒绝的~破坏了restful的url的一致性[严格矫正 不是http json就是restful 很多小伙伴都会吧暴露出一个json就直接称为restful ] 正如上文的代码生成器 我们会批量生成一堆代码 其中绝大部分都是RestController public abstract class AbstractRestController<V extends Vo, S extends So, PK extends Serializab

  • 在springboot中使用拦截器的步骤详解

    目录 在springboot中使用拦截器 1. 定义拦截器 2. 使用JavaConfig注册拦截器 3. 定义控制器,测试拦截器 4. 总结 在springboot中使用拦截器 拦截器Interceptor,是SpringMVC中的核心内容,利用spring的AOP(Aspect Oriented Programming, 面向切面编程)特性,可以很方便的对用户的业务代码进行横向抽取,根据具体业务需求对应用功能进行增强.在SpringBoot中使用Interceptor,同时采用全注解开发,涉

  • 在SpringBoot中该如何配置拦截器

    拦截器也是我们经常需要使用的,在SpringBoot中该如何配置呢 拦截器不是一个普通属性,而是一个类,所以就要用到java配置方式了.在SpringBoot官方文档中有这么一段说明: 翻译: 如果你想要保持Spring Boot 的一些默认MVC特征,同时又想自定义一些MVC配置(包括:拦截器,格式化器, 视图控制器.消息转换器 等等),你应该让一个类实现 WebMvcConfigurer ,并且添加 @Configuration 注 解,但是千万不要加 @EnableWebMvc 注解.如果

  • 详解如何在SpringBoot中自定义参数解析器

    目录 前言 1.自定义参数解析器 2.PrincipalMethodArgumentResolver 3.RequestParamMapMethodArgumentResolver 4.小结 前言 在一个 Web 请求中,参数我们无非就是放在地址栏或者请求体中,个别请求可能放在请求头中. 放在地址栏中,我们可以通过如下方式获取参数: String javaboy = request.getParameter("name "); 放在请求体中,如果是 key/value 形式,我们可以通

  • 详解SpringBoot中自定义和配置拦截器的方法

    目录 1.SpringBoot版本 2.什么是拦截器 3.工作原理 4.拦截器的工作流程 4.1正常流程 4.2中断流程 5.应用场景 6.如何自定义一个拦截器 7.如何使其在Spring Boot中生效 8.实际使用 8.1场景模拟 8.2思路 8.3实现过程 8.4效果体验 9.总结 1.SpringBoot版本 本文基于的Spring Boot的版本是2.6.7 . 2.什么是拦截器 Spring MVC中的拦截器(Interceptor)类似于ServLet中的过滤器(Filter),它

  • SpringBoot中利用AOP和拦截器实现自定义注解

    目录 前言 Spring实现自定义注解 1.引入相关依赖 2.相关类 Java实现自定义注解 通过Cglib实现 通过JDk动态代理实现 Cglib和JDK动态代理的区别 写在最后 前言 最近遇到了这样一个工作场景,需要写一批dubbo接口,再将dubbo接口注册到网关中,但是当dubbo接口异常的时候会给前端返回非常不友好的异常.所以就想要对异常进行统一捕获处理,但是对于这种service接口使用@ExceptionHandler注解进行异常捕获也是捕获不到的,应为他不是Controller的

  • 在springboot中如何给mybatis加拦截器

    目录 1.实现Interceptor接口,并添加拦截注解 @Intercepts 1.在mybatis中可被拦截的类型有四种(按照拦截顺序) 2.各个参数的含义 2.在配置文件中添加拦截器 (1)第一种 (2)第二种 (3)第三种 拦截器的作用就是我们可以拦截某些方法的调用,在目标方法前后加上我们自己逻辑 Mybatis拦截器设计的一个初衷是为了供用户在某些时候可以实现自己的逻辑而不必去动Mybatis固有的逻辑. mybatis 自定义拦截器 1.实现Interceptor 接口,并添加拦截注

  • 在SpringBoot项目中整合拦截器的详细步骤

    目录 引言 1.创建一个SpringBoot项目工程 2.配置自定义的拦截器 3.注册拦截器 4.编写控制器 总结 引言 拦截器在Web系统中非常常见,对于某些全局统一的操作,我们可以把它提取到拦截器中实现.总结起来,拦截器大致有以下几种使用场景: 1.权限检查:如登录检测,进入处理程序检测用户是否登录,如果没有,则直接返回登录页面或error错误页面: 2.性能检测:有时系统在某段时间莫名其妙很慢,我们可以通过拦截器在进入处理程序之前记录开始时间,在处理完后记录结束时间,从而得到该请求的处理时

  • springboot中使用redis由浅入深解析

    正文 很多时候,我们会在springboot中配置redis,但是就那么几个配置就配好了,没办法知道为什么,这里就详细的讲解一下 这里假设已经成功创建了一个springboot项目. redis连接工厂类 第一步,需要加上springboot的redis jar包 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-redi

  • SpringBoot快速设置拦截器并实现权限验证的方法

    一.概述 拦截器的使用场景越来越多,尤其是面向切片编程流行之后.那通常拦截器可以做什么呢? 之前我们在Agent介绍中,提到过统计函数的调用耗时.这个思路其实和AOP的环绕增强如出一辙. 那一般来说,场景如下: 函数增强:比如对一个函数进行参数检查,或者结果过滤等.甚至可以对函数就行权限认证. 性能监控:统计函数性能. 日志打点:比如在用户登录函数之前,打点统计PV等信息. 以及其他等等. 二.Spring的拦截器 无论是SpringMVC或者SpringBoot中,关于拦截器不得不提: org

随机推荐