From 0fe190c7f27876c5ad1d7a02765c72128a07286e Mon Sep 17 00:00:00 2001 From: lihengming <89921218@qq.com> Date: Mon, 26 Jun 2017 17:12:35 +0800 Subject: [PATCH] update > README --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index fa0ffa1..94c2fd3 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,14 @@ ### 简介 -Spring Boot API Project Seed 是一个基于Spring Boot & MyBatis的种子项目，用于快速构建纯API的项目（中小型项目)，该种子项目已经有过多个真实项目的实践，稳定、简单、快速，使我们摆脱那些重复劳动，专注于业务代码编写，减少加班。下面是一个简单的使用演示，看如何基于本项目在短短几秒钟内实现一套简单的API，并运行提供服务。 -![](http://chuantu.biz/t5/114/1498213687x2890174321.gif) +Spring Boot API Project Seed 是一个基于Spring Boot & MyBatis的种子项目，用于快速构建纯API的项目（中小型项目)，该种子项目已经有过多个真实项目的实践，稳定、简单、快速，使我们摆脱那些重复劳动，专注于业务代码编写，减少加班。下面是一个简单的使用演示，看如何基于本项目在短短几十秒钟内实现一套简单的API，并运行提供服务。 +[![](https://raw.githubusercontent.com/lihengming/shared-files/master/project-example-youku.png)](http://v.youku.com/v_show/id_XMjg1MDc5NDc4OA==.html?spm=a2h3j.8428770.3416059.1) ### 特征&提供 -- 最佳实践的项目结构、配置文件及精简的Maven依赖 +- 最佳实践的项目结构、配置文件及精简的Maven依赖（[查看项目结构图](https://github.com/lihengming/shared-files/blob/master/project-struct.png)） - 统一响应结果封装及生成工具 - 统一异常处理 - 常用基础方法抽象封装 - 集成MyBatis、通用Mapper插件、PageHelper分页插件，实现单表业务零SQL（相关使用文档在最下面有地址) -- 提供代码生成器根据表名生成对应的Model、Mapper、MapperXML、Service、ServiceImpl、Controller（默认提供post和rest两套Controller模板)等基础代码，代码模板可根据实际项目的需求来定制，以便渐少重复劳动（由于每个公司业务都不太一样，所以只提供了一些简单的通用方法模板，主要是提供一个思路来减少重复代码的编写，在我们公司的使用中，其实根据业务的抽象编写了大量的代码模板，下次再做类似的项目几天就完工了) +- 提供代码生成器根据表名生成对应的Model、Mapper、MapperXML、Service、ServiceImpl、Controller（默认提供post和restful两套Controller模板)等基础代码，代码模板可根据实际项目的需求来定制，以便渐少重复劳动（由于每个公司业务都不太一样，所以只提供了一些简单的通用方法模板，主要是提供一个思路来减少重复代码的编写，在我们公司的使用中，其实根据业务的抽象编写了大量的代码模板，下次再做类似的项目几天就完工了) - 另有彩蛋，待你探索   ### 快速开始 @@ -21,9 +21,9 @@ Spring Boot API Project Seed 是一个基于Spring Boot & MyBatis的种子项目   ### 开发建议 - 表名，应使用小写，多个单词使用下划线拼接 -- Model内成员变量建议于表字段相等，如需扩展成员变量(比如连表查询)，建议创建DTO，否则需在对应字段上加@Transist注解，详情见[通用Mapper插件文档说明]。 +- Model内成员变量建议于表字段相等，如需扩展成员变量（比如连表查询），建议创建DTO，否则需在对应字段上加@Transist注解，详情见[通用Mapper插件文档说明]。 - 建议业务失败使用```ServiceException(""message")```抛出，由统一异常处理器来封装JSON结果，比如```throw new ServiceException("该手机号已存在")```，会直接被封装为```{"code":400,"message":"该手机号已存在"}```返回，无需自己处理，尽情抛出。 -- 开发规范建议遵循阿里巴巴开发手册（[最新版下载]()) +- 开发规范建议遵循阿里巴巴Java开发手册（[最新版下载](https://github.com/lihengming/shared-files/blob/master/%E9%98%BF%E9%87%8C%E5%B7%B4%E5%B7%B4Java%E5%BC%80%E5%8F%91%E6%89%8B%E5%86%8Cv1.2.0.pdf))   ### 技术选型&文档 - Spring Boot（[查看Spring Boot学习&使用指南](http://www.jianshu.com/p/1a9fd8936bd8)）