SpringBoot2.1 RESTful API项目脚手架(种子)项目
最近在做一个大型的J2EE项目,后端语言选择了Java,理所当然的选择了Spring,使用Spring MVC来做restful风格的api开发很是方便,Spring下面有很多子项目通过Springboot集成也很舒服。程序员都知道沟通很重要,实际项目中,往往是各自为战,尽管使用的是相同的框架、工具,编写的代码却千差万别,为了统一基础代码风格,编写了这个项目种子。
除此之外,在开发一个Web后端api项目时,通常都会经历搭建项目、选择依赖管理工具、引入基础包依赖、配置框架等,为了加快项目的开发进度(早点下班)还需要封装一些常用的类和工具,如标准的响应结构体封装、统一异常处理切面、接口签名认证、初始化运行方法、轮询方法、api版本控制封装、异步方法配置等。
每次开始一个类型的新项目,以上这些步骤又要重复一遍,虽然能够将老项目拿过来删删减减达到目的,但还是很费时费力,还容易出问题。所以,可以利用面向对象的思想,抽取这类Web后端api项目的共同之处封装成一个项目种子。以后再开发类似的项目,就能直接在这个项目种子上迭代,减少重复劳动。
项目地址:https://github.com/ocubexo/springboot-restful-starter
简介
这是一个基于SpringBoot 2.1.1 RELEASE,用于搭建RESTful API工程的脚手架,只需三分钟你就可以开始编写业务代码,不再烦恼于构建项目与风格统一。
快速开始
- 构建数据库
- 运行
/src/test
下的CodeGenerator.java
进行代码生成 - 开始编写业务代码
内置功能与使用方法
RESTful风格Result生成器
1.成功且不带数据的结果
// 不带数据的成功结果 return new Result().success();
返回结果示例:
{ "code": 200, "message": "Success", "data": null }
2.成功且带返回数据的结果
return new Result().success("Hello,world"); // 当然你也可以返回对象或其他类型的数据 User user = new User(); return new Result().success(user);
返回结果示例:
{ "code": 200, "message": "Success", "data": "Hello,world" }
或者是:
{ "code": 200, "message": "Success", "data": { "name": "jack", "age": 20 } }
3.错误结果:
// fail方法的参数(错误代码,错误信息) return new Result().fail(10400, "登陆失败,密码错误"); // 你还可以自定义错误结果的code return new Result().fail(null, "未登录", 401);
返回结果示例:
{ "code": 400, "message": "登陆失败,密码错误", "data": 10400 }
或者:
{ "code": 401, "message": "未登录", "data": null }
RESTful风格的异常接管
// 参数说明(错误信息, 错误Code) throw new ServiceException("未登录", 401); // 你也可以返回错误代码 throw new ServiceException(10404, "服务器维护中", 404);
返回结果示例:
{ "code": 401, "message": "未登录", "data": null }
或者:
{ "code": 404, "message": "服务器维护中", "data": 10404 }
基于JWT的认证机制
@Autowired private TokenService tokenService; // 生成Payload Map<String,Object> payload = new HashMap<String,Object>(); payload.put("id",1); // 生成Token tokenService.generate(TokenType.ACCESS, payload, 1); // 格式化Token String token = getYourToken(); tokenService.parse(token); // 返回的结果是一个Jwt对象,详见JJWT文档 Auth注解 Auth注解用于获取当前用户的Token中的userId,在获取的同时会自动校验用户Token,若用户未登录则会抛出未登录的异常。 // 在controller中使用 @PostMapping("/user/1/edit") public Result edit(@Auth int userId, @ResponseBody sthPosted) { // 根据ID判断权限 }
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持脚本之家。
- Struts2 s2-032远程代码执行分析
- 微信企业号二次开发--自定义菜单接口开发--应用中心
- 微信最新自定义菜单事件
- 微信JSSDK分享到朋友圈和朋友自定义内容功能实现
- 无线安全渗透测试套件WiFi-Pumpkin新版本发布
- Java使用QQ邮箱给其他邮箱发邮件
- 从wireshark抓包开始学习https
- 用于时间序列预测的Python环境
- Pandoc安装实现Markdown转PDF (CentOS6)
- String类replaceAll方法正则替换深入分析
- 微信硬件平台对接--蓝牙
- 初试git+github(linux环境)
- Raspberry PI Nginx 安装
- 微信支付-Java-SpringMVC基础一些代码支持
- java教程
- Java快速入门
- Java 开发环境配置
- Java基本语法
- Java 对象和类
- Java 基本数据类型
- Java 变量类型
- Java 修饰符
- Java 运算符
- Java 循环结构
- Java 分支结构
- Java Number类
- Java Character类
- Java String类
- Java StringBuffer和StringBuilder类
- Java 数组
- Java 日期时间
- Java 正则表达式
- Java 方法
- Java 流(Stream)、文件(File)和IO
- Java 异常处理
- Java 继承
- Java 重写(Override)与重载(Overload)
- Java 多态
- Java 抽象类
- Java 封装
- Java 接口
- Java 包(package)
- Java 数据结构
- Java 集合框架
- Java 泛型
- Java 序列化
- Java 网络编程
- Java 发送邮件
- Java 多线程编程
- Java Applet基础
- Java 文档注释
- Red and Black(DFS 深搜练习)
- Codeforces Round #619 (Div. 2)
- 问题 1255: [蓝桥杯][算法提高]能量项链
- C# 开发技巧]如何防止程序多次运行 线程 进程
- 问题 1433: [蓝桥杯][2013年第四届真题]危险系数
- C# dev GridControl绑定数据不能显示
- Codeforces Round #621 (Div. 1 + Div. 2)(无比自闭的一夜)
- 牛客小白月赛22 A~~J
- P1914 小书童——密码
- sql server 2008 把远程的数据库的数据转移到本地数据数据库里
- 蓝桥杯 试题 基础练习 阶乘计算
- Java Lamada
- 试题 基础练习 高精度加法
- C# devExpress GridControl 行中行 子行 多级行
- 蓝桥杯 试题 基础练习 Huffuman树