工作需要,经常需要实现api接口,但每次都是大同小异,我就考虑是否可以将这种重复性的工作配置化。
我就写一个模板api,然后所有的HTTP请求过来,根据不同的配置返回不同结果。
最开始考虑的是比较简单的,来一个api需求,我就去MySQL查一条这个api对应的SQL,然后拿SQL去取结果,返回。
这个不难。
关键是实际需求中,有很多api返回的数据很复杂,比如渲染地图的接口,一般一条SQL搞不定。
那我就想,那我能不能实现api的拼装呢,你看到我只是调用了一个API,但是我给你返回的结果,其实是好几个API结果拼装成的。
经过研究,是可以实现的。
首先我们定义一个ApiConfig的模型
@Data @Table(name = "api_config") @AllArgsConstructor public class ApiConfig implements Serializable { @ApiModelProperty("api名称") private String apiName; @ApiModelProperty("数据源名称") private String dsName; @ApiModelProperty("SQL") private String querySql; @ApiModelProperty("结果类型") private String resultType; @ApiModelProperty("结果描述") private String resultDesc; @ApiModelProperty("依赖api") private String dependApiName; }
依赖api格式其实是一个json,它告诉我们,如果你还需要key1和key2的结果,需要分别从其他API(x/y/1,x/y/2)获取
{"key1":"x/y/1",
"key2":"x/y/2"}
接下来就是我们的实现类,因为是展现可行性,所以我们不分层,在一个Test类中把所有逻辑实现
@Slf4j public class Test { //测试数据的初始化 public static List<ApiConfig> apiConfigList = new ArrayList<>(); public static Map<String, String> sqlResultMap = ImmutableMap.of("sql1", "{"a":"1"}", "sql2", "{"b":"2"}", "sql3", "{"c":"3"}"); static { ApiConfig api1 = new ApiConfig("p1", "d1", "sql1", "map", "", "{"b":"p1/x1"}"); ApiConfig api2 = new ApiConfig("p1/x1", "d1", "sql2", "map", "", "{"c":"p1/x2"}"); ApiConfig api3 = new ApiConfig("p1/x2", "d1", "sql3", "map", "", null); apiConfigList.add(api1); apiConfigList.add(api2); apiConfigList.add(api3); } /** * 我要进行http:ip:port/p1这个请求,请返回我相关数据 * @param args */ public static void main(String[] args) { //根据api名称获取结果 String apiName = "p1"; JSONObject json = doGetResult(apiName); //result必须初始化,而且在方法内部不能重新new,以保证递归方法内更新的是同一个对象,否则拿不到更新数据后的result JSONVO result = null; if (json != null) { result = new JSONVO(json.toJSONString()); } else { result = new JSONVO("{}"); } //如有需要,递归获取子api的结果,并存入result getApiResult(apiName, null, result); System.out.println(result); } /** * 从子api查询结果,并更新到主result * @param apiName * @param dataKey * @param result */ public static void getApiResult(String apiName, String dataKey, JSONVO result) { //dataKey在进入方法时是等于null的,第二次进入肯定不应该为null,这个地方是更新result的关键位置 if (dataKey != null) { JSONObject json = doGetResult(apiName); result.set(dataKey, json); } //进入递归的入口 String dependApiName = getApiConfig(apiName).getDependApiName(); if (dependApiName != null) { JSONObject dependApi = JSONObject.parseObject(dependApiName); Set<String> keySet = dependApi.keySet(); for (String key : keySet) { String subApi = dependApi.getString(key); getApiResult(subApi, key, result); } } } public static JSONObject doGetResult(String apiName) { String querySql = getApiConfig(apiName).getQuerySql(); return doQuery(querySql); } /** * 根据api名称获取apiConfig * * @param api * @return */ public static ApiConfig getApiConfig(String api) { for (ApiConfig apiConfig : apiConfigList) { if (apiConfig.getApiName().equals(api)) { return apiConfig; } } log.error("api not exists!"); return null; } /** * 根据查询SQL获取结果 * * @param sql * @return */ public static JSONObject doQuery(String sql) { String s = sqlResultMap.get(sql); JSONObject jsonObject = JSONObject.parseObject(s); return jsonObject; } }
输出结果:
{"a":"1","b":{"b":"2"},"c":{"c":"3"}}
可以看到,两层递归的子api的数据都查出来了。
从数据库返回的结果,可能也不一定是JsonObject,这个在实现项目中需要在具体分析。