开源软件名称：PopularMVC
开源软件地址：https://gitee.com/danyuanblog/PopularMVC
开源软件介绍：
Popular MVC框架传送门Gitee源码地址：https://gitee.com/danyuanblog/PopularMVC 演示地址：http://www.danyuanblog.com:8181/doc.html 官方文档地址：http://www.danyuanblog.com/blog/app/blog/blogDetail.html?id=5fe86eb74c636312f4b70955 1、应用场景简介啥，听说你用了springboot，但是开发的接口还在裸奔？快来试试这个PopularMVC吧，它也许是你想要找的神器！
神器亮相 springboot叫一键启动，popularmvc为你的springboot项目插上翅膀，力求一键起飞！
1.1 项目架构说明1.1.1 PopularMVC跟Springboot的关系说明 - PopularMVC是基于springboot开发的，自然强依赖于springboot和springmvc
- PopularMVC在springboot提供的能力之上，为开发者编写API接口提供了很多额外的便利性
示意图
1.1.2 PopularMVC项目组件架构解析架构图 
组件介绍 主要分为以下几类组件 API调用拦截器 基于AOP切面设计的一套API请求、响应拦截处理流程。提供了在调用接口前后做一些通用的预处理，比如说参数校验、参数装饰、访问控制、日志输出、会话控制等等。目前内置的拦截器有： - 系统参数校验器
- 请求参数校验器
- 数字签名请求验签器、响应加签器
- 接口防重复提交控制器
- 接口用户会话控制器
- 接口日志打印器
- 接口访问控制器
- 请求、响应内容装饰器
也支持业务灵活定制通用的API调用拦截器。
参数装饰器 参数装饰器机制通过遍历参数内容，逐个字段进行修饰，具体修饰规则由特定的装饰器制定。常见的使用场景有，对请求参数解密、响应参数加密、响应参数国际化、响应参数脱敏等等 注意：参数装饰器只能对参数内容做修饰，而无法改变参数类型。 目前内置的参数装饰器有： - 请求参数解密器
- 响应参数加密器
- 系统参数自动填充器
- 响应参数国际化翻译器
也支持业务灵活拓展参数装饰器。
API响应序列化预处理器 响应预处理器机制可以在接口返回内容给调用者之前进行额外的处理，此时可以更灵活的修饰返回内容，可以突破无法修改参数类型的限制，适用于对整个响应结构定制化处理的场景。 目前内置的响应预处理器有： - API响应自动包装预处理器
- API响应错误码和系统参数定制化转换器
当然，也支持业务灵活拓展。
方法查询缓存拦截器 提供对查询类方法调用的结果进行缓存。
API异常统一处理器 接口调用过程中任何步骤出现异常，均能自动处理，并反馈信息给调用者。 支持对特定异常自定义处理，如果未处理，统一交由内置的默认异常处理器进行护理。
统一国际化翻译管理器 接口返回内容均支持国际化翻译能力。 已整合了spring i18n国际化翻译能力，也支持拓展业务自定义国际化翻译器。
统一错误码管理器 研发人员无需再关注业务错误码的定义和国际化翻译工作，可以做到定义简单、使用简单、易于理解、配置灵活 - 支持自定义系统错误码、业务错误码
- 支持业务错误码自动生成
- 支持业务错误码以异常的方式抛出，系统自动处理
自动接口文档生成器 已内置swagger+knif4j，只需指定API包路径即可实现接口文档的自动生成。
1.2 其他说明2、项目模块2.1 项目模块介绍2.2 项目版本依赖- popular-web-mvc 1.0.x-1.1.x版本使用到的第三方依赖如下所示
3、入门demo此demo是使用popularmvc的入门示例，演示了popularmvc在无侵入的模式下为你的项目提供了参数校验、业务异常的使用等功能，为了简化入门门槛，暂未提供其他功能的示例，如果需要学习使用更多功能，请参考更多示例。
3.1 项目结构项目结构 ├─src│ └─main│ ├─java│ │ └─com│ │ └─danyuanblog│ │ └─framework│ │ └─demo│ │ └─popularmvc│ │ ├─controller│ │ │ │ │ │ │ └─ TestController.java│ │ │ │ │ └─startup│ │ StartDemoApplication.java #项目启动类│ │ │ └─resources│ │ application.yml #项目配置信息，可省略│ │ │ └─i18n #自定义国际化支持，可省略│ └─messages #项目自定义国际化翻译信息│ messages.properties│ messages_en_US.properties│ messages_zh_CN.properties│ #还可添加其他国际化翻译内容└─ pom.xml 引入模块依赖，在pom.xml添加
<dependency> <groupId>com.danyuanblog.framework</groupId> <artifactId>popular-web-mvc</artifactId> <version>${popular-web-mvc.version}</version> </dependency>3.2 启用PopularMvc框架/** * Title StartDemoApplication.java * Description * @author danyuan* @date Oct 31, 2020* @version 1.0.0* site: www.danyuanblog.com*/ package com.danyuanblog.framework.demo.popularmvc;import org.springframework.boot.SpringApplication;import org.springframework.boot.autoconfigure.SpringBootApplication;import com.danyuanblog.framework.popularmvc.annotation.EnablePopularMvc;@SpringBootApplication@EnablePopularMvcpublic class StartDemoApplication { public static void main(String[] args) { SpringApplication.run(StartDemoApplication.class, args); }}3.3 测试接口代码示例代码如下，TestController.java /** * Title TestController.java * Description * @author danyuan* @date Dec 27, 2020* @version 1.0.0* site: www.danyuanblog.com*/ package com.danyuanblog.framework.demo.popularmvc.controller;import java.util.HashMap;import java.util.Map;import javax.validation.Valid;import javax.validation.constraints.NotBlank;import javax.validation.constraints.NotEmpty;import javax.validation.constraints.Size;import org.springframework.validation.annotation.Validated;import org.springframework.web.bind.annotation.GetMapping;import org.springframework.web.bind.annotation.PostMapping;import org.springframework.web.bind.annotation.RequestParam;import org.springframework.web.bind.annotation.RestController;import com.danyuanblog.framework.popularmvc.exception.BusinessException;@RestController@Validatedpublic class TestController { /** * 参数自动校验、响应内容自动包装功能示例 * @author danyuan */ @GetMapping("queryUserInfo") public Map<String,Object> queryUserInfo(@Valid @Size(max=20, min=6) @NotBlank @RequestParam String username){ System.out.println("查询用户["+username+"]的信息!"); //TODO: 执行业务逻辑 //mock数据 Map<String,Object> userInfos = new HashMap<>(); userInfos.put("username", username); userInfos.put("age", 23); userInfos.put("sex", "男"); userInfos.put("desc", "阳光乐观外向，喜欢唱歌、打篮球！"); //返回数据 return userInfos; } /** * 业务异常的使用示例 * @author danyuan */ @PostMapping("user/regist") public void userRegist(@Valid @NotEmpty String username, @Valid @NotEmpty String password){ //TODO: 执行业务逻辑，发现账号已存在，直接通过抛出异常的方式提示用户 throw new BusinessException("用户名[{0}]已存在，请更换!").setParam(username); }}
3.4 测试接口结果接口文档访问地址：http://localhost:8080/doc.html
3.4.1 测试参数校验请求参数 
结果 { "msg": "[参数异常]", #错误信息概览 "code": 120002, #系统错误码 "data": { "subErrors": [ { "error": "javax.validation.constraints.Size.message",#业务错误码 "msg": "[queryUserInfo.username]个数必须在6和20之间" #详细错误信息 } ] }}
3.4.2 测试正常响应信息返回请求参数 
结果 { "code": 0, "data": { "sex": "男", "age": 23, "username": "Jone Lacy", "desc": "阳光乐观外向，喜欢唱歌、打篮球！" }}
3.4.3 测试业务异常的使用请求参数 
结果 
{ "msg": "用户名[test]已存在，请更换!", "code": 200000}
3.5 更多功能示例系统内置接口 
业务系统接口 
接口文档示例 
接口测试示例 接口参数校验失败测试结果示例 
接口访问成功结果示例 
国际化接口访问示例（英文） 
国际化接口访问示例（中文） 
4、更多特性介绍与使用示例使用示例传送门 5、业务定制化5.1 配置定制化接口文档个性化 系统参数定制化 - 系统公共请求参数名自定义
- 添加额外的系统公共请求参数
- 系统公共响应参数名自定义
- 添加额外的系统响应参数
业务国际化内容 可以通过springboot i18n添加或者定制国际化内容
5.2 组件定制化PopularMVC提供了灵活定制通用组件的能力。 - 内置的几大管理器都可以替换成自定义的管理器，如：
- 缓存管理器
- 会话管理器
- 国际化管理器
- 数字签名管理器
- 秘钥管理器
- 应用管理器
- 接口日志管理器
- 接口调用频次控制管理器
- 可以添加自定义接口调用拦截器，实现一些通用业务
- 可以添加自定义接口请求、响应参数装饰器，对参数进行加工
- 可以添加自定义响应序列化预处理器，根据业务需要定制化返回信息
- 可以添加自定义异常处理器，为目标类型的异常做额外的处理
- 可以灵活定制和使用自定义的加解密处理器
6、交流与答疑 此项目的设计初衷源于本人在多年API接口开发经验上，从接口规范、开发便捷易用、配置简单这些角度出发而总结出来的一套API解决方案。通过简单引入PopularMVC组件，可以快速搭建一套规范易用的API开发系统。 开源的目的在于，一则希望此项目能帮助更多的研发人员提升API开发质量，提供大量易用的开发套件提升研发人员的开发效率；二则希望更多的人加入到开源中，促进开源项目的成长，然后服务于更多的开发者；其次希望觉得此项目不错的朋友给个Star，分享给更多的朋友，让大家一起进步！ 如果在使用此框架的过程中有任何疑问或者好的建议可以通过以下联系方式找到大部队，大家一起交流一起进步！
 |
客服电话
APP下载
官方微信
请发表评论