统一的Json组件和csv下载组件-阿里云开发者社区

开发者社区> rollenholt> 正文

统一的Json组件和csv下载组件

简介:
+关注继续查看

java-web-common

java-web-common

Json组件

目标和用途

  • 规范Json接口格式
  • Controller中一律返回Java object,组件将自动转换数据格式,满足Json接口格式
  • 统一处理Json接口中出现的异常,controller中不再需要try-catch.Spring只有针对页面请求的SimpleMappingExceptionResolver异常解决方案,并没有针对使用@ResponseBody的方法异常处理

如何使用

  • 在Spring配置文件中增加:<context:component-scan base-package="ren.wenchao.web.common, your-controller-packages" />
  • 不需要配置<mvn:annotation-driven/>
  • 在需要返回Json的Controller的方法上标注:@JsonResponseBody 注解,默认是V2版本。可以参考TestController.java文件

示例

示例1

  @RequestMapping(value = "/testJsonResponceBodyV2ReturnMap")
   @JsonResponseBody(version = JsonResponseBody.Version.V2)
   public Map testJsonResponceBodyV2ReturnMap() {
       HashMap<Object, Object> hashMap = Maps.newHashMap();
       hashMap.put("key", "value");
       return hashMap;
   }

返回:

{
    "code":0,
    "msg":"",
    "data":{
        "key":"value"
    }
}

示例2

    @RequestMapping(value = "/testJsonResponceBodyV1WithException")
    @JsonResponseBody(version = JsonResponseBody.Version.V1)
    public List<String> testJsonResponceBodyV1WithException() {
        throw new RuntimeException("some exception");
    }

返回:

{
    "ret":false,
    "msg":"some exception"
}

更多示例请参考:TestController.java

CSV组件

目标和用途

  • 提供一个统一的CSV文件下载功能,各个系统就不需要重复编写了
  • 简化「cvs下载功能」的实现

如何使用

  • 假设你的业务model为Payload,有可能你最终需要的csv的列和业务model Payload的属性不完全一致,
    因此你需要创建一个SomeCSVPayload(名字随意)来实现BaseCSVPayload接口,并制定csv的列头等信息
  • 在对应的Controller方法上增加@CSVResponceBody(fileName = "output", payloadClass = SomeCSVPayload.class),如下:
    @RequestMapping(value = "/testCSVResponceBody")
    @CSVResponceBody(fileName = "output", payloadClass = SomeCSVPayload.class)
   public SomeCSVPayload testCSVResponceBody() {
       return new SomeCSVPayload();
   }      

示例使用请查看TestController.java中的testCSVResponceBody方法

Excel组件

暂时没打算支持Excel下载,因为Excel需要区分版本,不同版本的限制也有些不同,而CSV比较通用,因此目前只支持csv

版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

相关文章
React.js 实战之深入理解组件
sublime 插件安装 用Package Control安装 按下Ctrl+Shift+P调出命令面板 输入install 调出 Install Package 选项并回车,然后在列表中选中要安装的插件 function形式 es6形式 state属性 用来存储组件自身需要的数据。
955 0
怎么设置阿里云服务器安全组?阿里云安全组规则详细解说
阿里云服务器安全组设置规则分享,阿里云服务器安全组如何放行端口设置教程
8383 0
如何对第一个Vue.js组件进行单元测试 (上)
单元测试是持续集成的关键。通过专注于小的、独立的实体,确保单元测试始终按预期运行,使代码更加可靠,你可以放心地迭代你的项目而不必担坏事儿
1727 0
+关注
406
文章
0
问答
文章排行榜
最热
最新
相关电子书
更多
《2021云上架构与运维峰会演讲合集》
立即下载
《零基础CSS入门教程》
立即下载
《零基础HTML入门教程》
立即下载