步驟:
1、編寫接口文檔
2、執行代碼生成工具生成代碼
接口文檔請求報文:

返回報文:

約定和說明
1、接口字段的命名采用駝峰命名法,與表結構字段保持一致(表結構采用的是下劃線命名方式)
2、約束說明

3、類型說明

4、長度說明

5、請求參數分為請求頭參數(reqHead),請求體參數(reqBody)
請求頭參數(reqHead)是所有調用請求的公共入參部分,所有接口請求頭參數都一致;
請求體參數(reqBody)是具體業務參數部分,不同接口參數不同
請求頭參數如下:

6、返回報文按照如下固定格式:

7、rspCode返回碼的定義

編寫完成后進入RestfulGenerator類,修改相關信息后執行main方法
```
import java.io.IOException;
import org.walkframework.restful.generator.Config;
import org.walkframework.restful.generator.JavaFileBuilder;
/**
* 接口請求報文與返回報文生成器
*
*/
public class RestfulGenerator {
/**
* 直接執行本方法生成
*
* @param args
* @throws Exception
*/
public static void main(String[] args) throws Exception {
//生成模型代碼
startGenCode();
}
/**
* 生成模型代碼
*
* @throws Exception
*/
public static void startGenCode() throws Exception {
Config config = Config.DEFAULT;
// 1、設置是否覆蓋原有文件,此項配置要注意!!!
config.setOverride(true);
// 2、設置請求報文包名
config.setReqPackageName("com.asiainfo.walk.msaleapi.mvc.model.order.req");
// 3、設置返回報文包名
config.setRspPackageName("com.asiainfo.walk.msaleapi.mvc.model.order.rsp");
// 4、設置屬性翻譯器包名
config.setTranslatorPackageName("com.asiainfo.walk.msaleapi.mvc.service.order.translator");
// 5、設置Excel文檔目錄。接口文檔示例請到該目錄下查看:src/main/webapp/static/demo/doc
config.setExcelFileDir("D:/Workspace/HLJ/msale/doc/接口文檔/bak");
// 6、設置生成的.java文件存放目錄位置
config.setCodeDirPath("D:/Workspace/HLJ/msale/gen");
// 7、執行...
JavaFileBuilder.newInstance().builder(config);
// 8、打開生成好的代碼文件目錄
openDir(config.getCodeDirPath());
}
// 打開輸出目錄
private static void openDir(String openDir) {
try {
String osName = System.getProperty("os.name");
if (osName != null) {
if (osName.contains("Mac")) {
Runtime.getRuntime().exec("open " + openDir);
} else if (osName.contains("Windows")) {
Runtime.getRuntime().exec("cmd /c start " + openDir);
}
}
} catch (IOException e) {
e.printStackTrace();
}
}
}
```
- walk簡介
- 核心模塊
- walk-data
- IData
- EntityHelper
- walk-cache
- 緩存管理器
- 緩存對象
- 緩存注解
- walk-batis
- 單表操作
- 批量操作
- 列表/分頁查詢
- 所有方法列表
- sql熱部署
- 二級緩存
- 數據庫方言
- 其他使用技巧
- 實體類生成工具
- walk-mq
- 隊列管理器
- 隊列對象
- 訂閱/發布管理器
- 訂閱器
- 發布器
- walk-shiro
- 用戶認證/授權
- url動態授權/回收
- 分布式會話
- 無狀態會話支持
- walk-base
- 前端基礎框架
- 公共頁面
- 自定義標簽
- 自定義函數
- 組件及工具
- 后端基礎框架
- 基礎結構
- 表單校驗
- 數據導入
- 數據導出
- 上傳下載
- 靜態參數加載器
- 靜態參數翻譯器
- 實體類翻譯器
- sql翻譯器
- 自定義翻譯器
- 靜態參數校驗器
- 分布式任務
- 增刪改查代碼生成器
- walk-restful
- 請求報文
- 返回報文
- 節點翻譯器
- api代碼生成
- walk-activiti
- 接口封裝
- 模型管理
- 流程圖展示
- 集成方法
- walk-console
- 在線會話管理
- 靜態參數表緩存管理
- 緩存管理
- 隊列管理
- 發布/訂閱管理
- walk-boot
- 常用功能
- 持久層操作
- 分布式緩存
- 分布式會話
- 分布式任務
- 前端常用功能
- 后端常用功能
- 工作流封裝
- 多數據源支持
- 關于讀寫分離
- 常用工具類
- 代碼生成工具
- SpringCloud集成
- 阿里edas平臺支持
- 其他
- 開發規約
- 環境要求
- 工程示例
- 工程結構
- web工程
- API工程
- 后臺任務
- 常見問題
- 事務不生效
- 分布式任務不生效
- 事務鎖
- 變更歷史