Java-web-多个独立项目之间相互调用实践
本篇文章只涉及到应用层面，没有涉及到什么底层原理之类的，我目前的实力还没有达到那个级别。如果是大神级别的人看到这篇文章，请跳过。
项目框架也已经是搭建好了的，springboot版本为1.5，数据库操作使用的是Mybatis，数据库使用的Oracle，前端使用VUE，Node.js打包之类的。由于
实际需要，要在多个项目之间相互调用，其中一种方式是访问一个固定的项目，只有一台服务器；还有一种方式是调用一个项目，该项目部署了多台服
务器。
调用方式一
通过一个项目调用另外一个项目，调用地址固定，调用方式为通过 RestTemplate 这个类来进行调用，由spring提供。这样调用的原因是当前这个
项目中有不同的数据源，除了Oracle的还有其他的数据库，可是其他的数据库连接资源有限，除了我们负责的子项目在调用外，其他人也在进行调用。
所以最后就将被调用方做成了一个单独的服务，让其他系统之间可以直接调用。大致的实现方式为拿到传递的参数，通过反射的方式拿到对应的service
实现类，然后通过serviceImpl调用Mapper.java中的方法执行增、删、改、查操作，最后将返回的结果返回给调用方。请求时参数的传递方式为通过
Map<String, String>传输，被调用方通过Map<String, String>可以直接获取到参数信息。然后通过自定义的JSON工具类来解析数据，分为单个对象
数据、列表数据、分页数据。经过反复的调试，最终很好的实现了需求，解决了当前项目中存在的问题。
解析返回参数的工具类为//
@Slf4j
@Component
@Scope(value = "singleton")//显示单例
public class AnalysisGBaseDataUtils implements InitializingBean {
//私有化构造方法
private AnalysisGBaseDataUtils(){}
private static RestTemplate restTemplate = new RestTemplate();
private static String gbaseApi;
@Value("${gbase.api.prefix}")
private String getGbaseApi;
@Override
public void afterPropertiesSet() throws Exception {
AnalysisGBaseDataUtils.gbaseApi = this.getGbaseApi;
}
/**
* @Description: 方法参数校验
* @author: 1
* @date: 2020-9-5 10:13:10
* @param: @param <E>
* @param: @param dataMap
* @param: @param e
* @param: @return
* @return: String
*/
private static <E> String paramValidate(Map<String, Object> dataMap, E e) {
if(Objects.equal(dataMap, null)) {
throw new BaseException(MessageConstant.A000001, "dataMap参数错误");
}
if(Objects.equal(e, null)) {
throw new BaseException(MessageConstant.A000001, "E类型参数错误");
}
if(Objects.equal(dataMap.get("methodName"), null)) {
throw new BaseException(MessageConstant.A000001, "dataMap中methodName参数不能为null!");
}
if(Objects.equal(dataMap.get("serviceId"), null)) {
throw new BaseException(MessageConstant.A000001, "dataMap中serviceId参数不能为null!");
}
String methodName = (String)dataMap.get("methodName");
String serviceId = (String)dataMap.get("serviceId");
if(StringUtils.isBlank(methodName)) {
throw new BaseException(MessageConstant.A000001, "dataMap中methodName参数错误!");
}
if(StringUtils.isBlank(serviceId)) {
throw new BaseException(MessageConstant.A000001, "dataMap中serviceId参数错误!");
}
return methodName;
}
/**
* @Description: 抽取列表数据解析方法
* @author: 1
* @date: 2020-9-5 10:13:30
* @param: @param <E>
* @param: @param methodName
* @param: @param resultStr
* @param: @param e
* @param: @return
* @return: List<? extends Object>
*/
private static <E> List<? extends Object> analysisData(String methodName, String resultStr, E e) {
List<? extends Object> parseArray = JsonUtils.parseArray(resultStr,"data", e.getClass());
return parseArray;
}
/**
* @Description: 解析分页数据：新方法，使用更方便(直接传入 class 对象)，备用
* @author: 1
* @date: 2020-9-21 21:41:03
* @param: @param <E>
* @param: @param dataMap
* @param: @param clazz
* @param: @return
* @return: Page<E>
*/
public static final<E> Page<E> getPageData(Map<String, Object> dataMap, final Class<E> clazz) {
E e = AnalysisGBaseDataUtils.getInstance(clazz);
String methodName = AnalysisGBaseDataUtils.paramValidate(dataMap, e);
Page<E> pages = null;
String resultStr = AnalysisGBaseDataUtils.sendRequest(dataMap, methodName);
try {
pages = new Page<E>();
String pageData = JsonUtils.getSubJson(resultStr, "data");
pages.setCount(true);
if(Objects.equal("[]", pageData)) {
//未获取到数据
pages.setPageNum(1);
pages.setPageSize(10);
pages.setTotal(0);
pages.setPages(0);
}else {
pages.setPageNum(JsonUtils.parse(pageData, "pageNum"));
pages.setPageSize(JsonUtils.parse(pageData, "pageSize"));
Integer total = JsonUtils.parse(pageData, "total");
pages.setTotal(total);
pages.setPages(JsonUtils.parse(pageData, "pages"));
List<? extends Object> parseArray = AnalysisGBaseDataUtils.analysisData(methodName, pageData, e);
if(!Objects.equal(parseArray, null)) {
for (Object obj : parseArray) {
pages.add((E) obj);
}
}
}
}catch(Exception error) {
AnalysisGBaseDataUtils.log.error(methodName + "-方法-getPageData(clazz)-数据解析错误: " + error.getMessage(), error);
throw new BaseException(MessageConstant.A000001, methodName + "-方法-getPageData(clazz)-数据解析错误");
}
return pages;
}
/**
* @Description: 解析列表数据：新方法，使用更方便(直接传入 class 对象)，备用
* @author: 1
* @date: 2020-9-22 14:18:22
* @param: @param <E>
* @param: @param dataMap
* @param: @param clazz
* @param: @return
* @return: List<E>
* @throws IllegalAccessException
* @throws InstantiationException
*/
public static final<E> List<E> getListData(Map<String, Object> dataMap, final Class<E> clazz) {
List<E> resultList = new ArrayList<E>();
E e = AnalysisGBaseDataUtils.getInstance(clazz);
String methodName = AnalysisGBaseDataUtils.paramValidate(dataMap, e);
String resultStr = AnalysisGBaseDataUtils.sendRequest(dataMap, methodName);
try {
List<? extends Object> parseArray = AnalysisGBaseDataUtils.analysisData(methodName, resultStr, e);
if(!Objects.equal(parseArray, null)) {
for (Object object : parseArray) {
resultList.add((E) object);
}
}
}catch(Exception error) {
AnalysisGBaseDataUtils.log.error(methodName + "-方法getListData(clazz)数据解析错误: " + error.getMessage(), error);
throw new BaseException(MessageConstant.A000001, methodName + "-方法getListData(clazz)数据解析错误");
}
return resultList;
}
/**
* @Description: 解析单条数据：新方法，使用更方便(直接传入 class 对象)，备用
* @author: 1
* @date: 2020-9-5 10:12:04
* @param: @param <E>
* @param: @param dataMap
* @param: @param e
* @param: @return
* @return: E
*/
public static final <E> E getBeanData(Map<String, Object> dataMap, final Class<E> clazz) {
E e = AnalysisGBaseDataUtils.getInstance(clazz);
String methodName = AnalysisGBaseDataUtils.paramValidate(dataMap, e);
String resultStr = AnalysisGBaseDataUtils.sendRequest(dataMap, methodName);
try {
e = (E) JsonUtils.parse(resultStr, "data", clazz);
}catch(Exception error) {
AnalysisGBaseDataUtils.log.error(methodName + "-方法-getBeanData(clazz)-数据解析错误: " + error.getMessage(), error);
throw new BaseException(MessageConstant.A000001, methodName + "-方法-getBeanData(clazz)-数据解析错误");
}
return e;
}
/**
* @Description: 抽取发送请求的方法
* @author: 1
* @date: 2020-9-28 13:55:24
* @param: @param dataMap
* @param: @param methodName
* @param: @return
* @return: String
*/
private static String sendRequest(Map<String, Object> dataMap, String methodName) {
String resultStr = AnalysisGBaseDataUtils.restTemplate.postForObject(AnalysisGBaseDataUtils.gbaseApi, dataMap, String.class);
Integer code = JsonUtils.parse(resultStr, "code");
if(!Objects.equal(code, 20000)) {
String msg = JsonUtils.parse(resultStr, "msg", String.class);
AnalysisGBaseDataUtils.log.error(methodName + "-方法-sendRequest-操作错误: {}",msg );
throw new BaseException(MessageConstant.A000001, methodName + "-方法-sendRequest-操作错误: " + msg);
}
return resultStr;
}
/**
* @Description: 抽取获取实例的方法
* @author: 1
* @date: 2020-9-28 14:04:42
* @param: @param <E>
* @param: @param clazz
* @param: @return
* @return: E
*/
private static final<E> E getInstance(final Class<E> clazz) {
E e = null;
try {
e = (E) clazz.newInstance();
} catch (InstantiationException | IllegalAccessException error) {
AnalysisGBaseDataUtils.log.error(clazz.toString() + "-方法-getInstance-获取实例错误: " + error.getMessage(), error);
throw new BaseException(MessageConstant.A000001, clazz.toString() + "-方法-getInstance-获取实例错误");
}
return e;
}
}
JSONUtils工具类为//
public class JsonUtils {
/**
* <pre>
* 对象转化为json字符串
*
* @param obj 待转化对象
* @return 代表该对象的Json字符串
*/
public static final String toJson(final Object obj) {
return JSON.toJSONString(obj);
// return gson.toJson(obj);
}
/**
* <pre>
* 对象转化为json字符串
*
* @param obj 待转化对象
* @return 代表该对象的Json字符串
*/
public static final String toJson(final Object obj, SerializerFeature... features) {
return JSON.toJSONString(obj, features);
// return gson.toJson(obj);
}
/**
* 对象转化为json字符串并格式化
*
* @param obj
* @param format 是否要格式化
* @return
*/
public static final String toJson(final Object obj, final boolean format) {
return JSON.toJSONString(obj, format);
}
/**
* 对象对指定字段进行过滤处理，生成json字符串
*
* @param obj
* @param fields 过滤处理字段
* @param ignore true做忽略处理，false做包含处理
* @param features json特征，为null忽略
* @return
*/
public static final String toJson(final Object obj, final String[] fields, final boolean ignore,
SerializerFeature... features) {
if (fields == null || fields.length < 1) {
return toJson(obj);
}
if (features == null)
features = new SerializerFeature[] { SerializerFeature.QuoteFieldNames };
return JSON.toJSONString(obj, new PropertyFilter() {
@Override
public boolean apply(Object object, String name, Object value) {
for (int i = 0; i < fields.length; i++) {
if (name.equals(fields[i])) {
return !ignore;
}
}
return ignore;
}
}, features);
}
/**
* <pre>
* 解析json字符串中某路径的值
*
* @param json
* @param path
* @return
*/
@SuppressWarnings("unchecked")
public static final <E> E parse(final String json, final String path) {
String[] keys = path.split(",");
JSONObject obj = JSON.parseObject(json);
for (int i = 0; i < keys.length - 1; i++) {
obj = obj.getJSONObject(keys[i]);
}
return (E) obj.get(keys[keys.length - 1]);
}
/**
* <pre>
* json字符串解析为对象
*
* @param json 代表一个对象的Json字符串
* @param clazz 指定目标对象的类型，即返回对象的类型
* @return 从json字符串解析出来的对象
*/
public static final <T> T parse(final String json, final Class<T> clazz) {
return JSON.parseObject(json, clazz);
}
/**
* <pre>
* json字符串解析为对象
*
* @param json json字符串
* @param path 逗号分隔的json层次结构
* @param clazz 目标类
*/
public static final <T> T parse(final String json, final String path, final Class<T> clazz) {
String[] keys = path.split(",");
JSONObject obj = JSON.parseObject(json);
for (int i = 0; i < keys.length - 1; i++) {
obj = obj.getJSONObject(keys[i]);
}
String inner = obj.getString(keys[keys.length - 1]);
return parse(inner, clazz);
}
/**
* 将制定的对象经过字段过滤处理后，解析成为json集合
*
* @param obj
* @param fields
* @param ignore
* @param clazz
* @param features
* @return
*/
public static final <T> List<T> parseArray(final Object obj, final String[] fields, boolean ignore,
final Class<T> clazz, final SerializerFeature... features) {
String json = toJson(obj, fields, ignore, features);
return parseArray(json, clazz);
}
/**
* <pre>
* 从json字符串中解析出一个对象的集合，被解析字符串要求是合法的集合类型
* （形如:["k1":"v1","k2":"v2",..."kn":"vn"]）
*
* @param json - [key-value-pair...]
* @param clazz
* @return
*/
public static final <T> List<T> parseArray(final String json, final Class<T> clazz) {
return JSON.parseArray(json, clazz);
}
/**
* <pre>
* 从json字符串中按照路径寻找，并解析出一个对象的集合，例如：
* 类Person有一个属性name，要从以下json中解析出其集合：
* {
* "page_info":{
* "items":{
* "item":[{"name":"KelvinZ"},{"name":"Jobs"},...{"name":"Gates"}]
* }
* }
* 使用方法：parseArray(json, "page_info,items,item", Person.class)，
* 将根据指定路径，正确的解析出所需集合，排除外层干扰
*
* @param json json字符串
* @param path 逗号分隔的json层次结构
* @param clazz 目标类
* @return
*/
public static final <T> List<T> parseArray(final String json, final String path, final Class<T> clazz) {
String[] keys = path.split(",");
JSONObject obj = JSON.parseObject(json);
for (int i = 0; i < keys.length - 1; i++) {
obj = obj.getJSONObject(keys[i]);
}
String inner = obj.getString(keys[keys.length - 1]);
List<T> ret = parseArray(inner, clazz);
return ret;
}
/**
* <pre>
* 有些json的常见格式错误这里可以处理，以便给后续的方法处理
* 常见错误：使用了\" 或者 "{ 或者 }"，腾讯的页面中常见这种格式
*
* @param invalidJson 包含非法格式的json字符串
* @return
*/
public static final String correctJson(final String invalidJson) {
String content = invalidJson.replace("\\\"", "\"").replace("\"{", "{").replace("}\"", "}");
return content;
}
/**
* 格式化Json
*
* @param json
* @return
*/
public static final String formatJson(String json) {
Map<?, ?> map = (Map<?, ?>) JSON.parse(json);
return JSON.toJSONString(map, true);
}
/**
* 获取json串中的子json
*
* @param json
* @param path
* @return
*/
public static final String getSubJson(String json, String path) {
String[] keys = path.split(",");
JSONObject obj = JSON.parseObject(json);
for (int i = 0; i < keys.length - 1; i++) {
obj = obj.getJSONObject(keys[i]);
System.out.println(obj.toJSONString());
}
return obj != null ? obj.getString(keys[keys.length - 1]) : null;
}
}
通过这种方式很好的解决了当前项目中需要相互调用的问题，而且也非常适合当前项目的实际情况。
这中间遇到一个比较棘手的问题是，在数据返回时，分页数据不能直接使用，需要转换一次才能使用。
转换方法也很简单，如下，
由于该项目的访问量不是太大，因此这种方式完全符合要求，解决了项目中存在的问题。
调用方式二
第二种调用方式和第一种有些区别，第二种调用方式的项目部署了多台服务器，如果仍然通过第一种方式来调用则不能满足要求。
第一种调用方式只适合有一台服务器的情况，第二种就只能通过feign来调用了。这种调用方式的作用在于通过调用来实现数据的同步。
先看一下当前项目中的一种实现方式，先定义feign调用的接口，然后定义一个feign接口的实现类，然后在写一个具体的调用接口和实现
类。在具体的实现类中，将feign接口当做成员变量，然后调用feign接口种的方法实现调用。最后实际调用时，是通过callFixDataService
实现调用的。
CallBigDataFeign
CallBigDataFeignFallBack
CallFixDataService
CallFixDataServiceImpl
最终调用方式，通过fastJson包下面的JSONObject和JSONOArray来进行调用。
配置方式为，地址可以配置多个，中间使用逗号分隔。
最终通过测试，这种方式完全符合业务要求，实现了一个项目调用另外一个部署在多台服务器上的项目。
