建站
咨詢
售后
建站咨詢
新聞中心
這里有您想知道的互聯(lián)網(wǎng)營銷解決方案
后端思維之通過層層代碼去重，我又搞了一個通用模板
后端思維
大家好,我是田螺。
成都創(chuàng)新互聯(lián)公司專注于山陽企業(yè)網(wǎng)站建設(shè),成都響應(yīng)式網(wǎng)站建設(shè)公司,成都做商城網(wǎng)站。山陽網(wǎng)站建設(shè)公司,為山陽等地區(qū)提供建站服務(wù)。全流程按需策劃，專業(yè)設(shè)計，全程項目跟蹤，成都創(chuàng)新互聯(lián)公司專業(yè)和態(tài)度為您提供的服務(wù)
后端思維系列好久沒更新啦~今天，終于來了。本文是田螺哥后端思維專欄的第7篇哈。
最近工作中,我通過層層優(yōu)化重復(fù)代碼,最后抽出個通用模板.因此跟大家分享一下優(yōu)化以及思考的過程。我會先造一個相似的例子,然后一步步帶大家如何優(yōu)化哈,看完一定會有幫助的。
- 優(yōu)化前的例子
- 第一步優(yōu)化：抽取公用方法
- 第二步優(yōu)化：反射對比字段
- 第三步優(yōu)化：泛型+ lambda函數(shù)式
- 第四步優(yōu)化：繼承多態(tài)
- 第五步優(yōu)化：模板方法成型
- 大功告成: 策略模式+工廠模式+模板方法模式
1. 優(yōu)化前的例子
在這里,我先給大家模擬一個業(yè)務(wù)場景哈,并給出些簡化版的代碼
假設(shè)你有個對賬需求:你要把文件服務(wù)器中,兩個A、B不同端，上送的余額明細(xì)和轉(zhuǎn)賬明細(xì),下載下來,對比每個字段是否一致.
明細(xì)和余額的對比類似,代碼整體流程:
- 讀取A、B端文件到內(nèi)存的兩個list
- 兩個list通過某個唯一key轉(zhuǎn)化為map
- 兩個map字段逐個對比
我們先看明細(xì)對比哈，可以寫出類似醬紫的代碼:
//對比明細(xì)
private void checkDetail(String detailPathOfA,String detailPathOfB )throws IOException{
//讀取A端的文件
List resultListOfA = new ArrayList<>();
try (BufferedReader reader1 = new BufferedReader(new FileReader(detailPathOfA))) {
String line;
while ((line = reader1.readLine()) != null) {
resultListOfA.add(DetailDTO.convert(line));
}
}
//讀取B端的文件
List resultListOfB = new ArrayList<>();
try (BufferedReader reader1 = new BufferedReader(new FileReader(detailPathOfB))) {
String line;
while ((line = reader1.readLine()) != null) {
resultListOfB.add(DetailDTO.convert(line));
}
}
//A列表轉(zhuǎn)化為Map
Map resultMapOfA = new HashMap<>();
for(DetailDTO detail:resultListOfA){
resultMapOfA.put(detail.getBizSeq(),detail);
}
//B列表轉(zhuǎn)化為Map
Map resultMapOfB = new HashMap<>()
for(DetailDTO detail:resultListOfB){
resultMapOfB.put(detail.getBizSeq(),detail);
}
//明細(xì)逐個對比
for (Map.Entry temp : resultMapOfA.entrySet()) {
if (resultMapOfB.containsKey(temp.getKey())) {
DetailDTO detailOfA = temp.getValue();
DetailDTO detailOfB = resultMapOfB.get(temp.getKey());
if (!detailOfA.getAmt().equals(detailOfB.getAmt())) {
log.warn("amt is different,key:{}", temp.getKey());
}
if (!detailOfA.getDate().equals(detailOfB.getDate())) {
log.warn("date is different,key:{}", temp.getKey());
}
if (!detailOfA.getStatus().equals(detailOfB.getStatus())) {
log.warn("status is different,key:{}", temp.getKey());
}
......
}
}
} 2. 抽取公用方法去重
大家仔細(xì)看以上明細(xì)對比的例子,發(fā)現(xiàn)了重復(fù)代碼:
圖片
我們可以抽取一個公用方法去優(yōu)化它,比如抽取個讀取文件的公用方法 readFile:
//對比明細(xì)
private void checkDetail(String detailPathOfA,String detailPathOfB )throws IOException{
//讀取A端的文件
List resultListOfA = readFile(detailPathOfA);
//讀取B端的文件
List resultListOfB = readFile(detailPathOfB);
......
}
//抽取公用方法
private List readFile(String detailPath) throws IOException {
List resultList = new ArrayList<>();
try (BufferedReader reader1 = new BufferedReader(new FileReader(detailPath))) {
String line;
while ((line = reader1.readLine()) != null) {
resultList.add(DetailDTO.convert(line));
}
}
return resultList;
} 同理，這塊代碼也是重復(fù)了:
圖片
我們也可以抽個公用方法:convertListToMap
//對比明細(xì)
private void checkDetail(String detailPathOfA,String detailPathOfB ){
//讀取A端的文件
List resultListOfA = readFile(detailPathOfA);
//讀取B端的文件
List resultListOfB = readFile(detailPathOfB);
//A列表轉(zhuǎn)化為Map
Map resultMapOfA = convertListToMap(resultListOfA);
//B列表轉(zhuǎn)化為Map
Map resultMapOfB = convertListToMap(resultListOfB);
......
}
//抽取公用方法
private Map convertListToMap(List list){
Map map = new HashMap<>()
for(DetailDTO detail:list){
map.add(detail.getBizSeq(),detail);
}
return map;
} 通過抽取公用方法后，已經(jīng)優(yōu)雅很多啦~
3. 反射對比字段
我們再來看下字段對比的邏輯，如下：
圖片
以上代碼會取兩個對象的每個字段對比，如果明細(xì)對象的屬性字段特別多的話，這塊代碼也會顯得重復(fù)冗余。我們可以通過反射去對比兩個對象的屬性，如下：
public static List compareObjects(Object obj1, Object obj2) {
List list = new ArrayList<>();
Class clazz = obj1.getClass();
Field[] fields = clazz.getDeclaredFields();
for (Field field : fields) {
String fieldName = field.getName();
field.setAccessible(true);
try {
Object value1 = field.get(obj1);
Object value2 = field.get(obj2);
if ((value1 == null && value2 != null) || (value1 != null && !value1.equals(value2))) {
list.add(fieldName);
}
} catch (IllegalAccessException e) {
e.printStackTrace();
}
}
return list;
} 有了這個反射對比方法，原來的代碼就可以優(yōu)化成這樣啦，是不是優(yōu)雅了很多:
//對比明細(xì)
private void checkDetail(String detailPathOfA,String detailPathOfB ){
//讀取A端的文件
List resultListOfA = readFile(detailPathOfA);
//讀取B端的文件
List resultListOfB = readFile(detailPathOfB);
//A列表轉(zhuǎn)化為Map
Map resultMapOfA = convertListToMap(resultListOfA);
//B列表轉(zhuǎn)化為Map
Map resultMapOfB = convertListToMap(resultListOfB);
//明細(xì)逐個對比
for (Map.Entry temp : resultMapOfA) {
if(resultMapOfB.containsKey(temp.getKey()){
DetailDTO detailOfA = temp.getValue();
DetailDTO detailOfB = resultMapOfB.get(temp.getKey());
List resultList=compareObjects(detailOfA,detailOfB);
for(String temp:resultList){
log.warn("{} is different,key:{}",temp,detailOfA.getKey());
}
......
}
}
} 4.Lambda函數(shù)式+泛型
實現(xiàn)完明細(xì)文件的對比,我們還需要余額文件的對比:
同樣的,也是先讀取文件,如下:
//對比明細(xì)
private void checkBalance(String balancePathOfA,String balancePathOfB ){
//讀取A端的文件
List resultListOfA = new ArrayList<>();
try (BufferedReader reader1 = new BufferedReader(new FileReader(balancePathOfA))) {
String line;
while ((line = reader1.readLine()) != null) {
resultListOfA.add(BalanceDTO.convert(line));
}
}
List resultListOfB = new ArrayList<>();
try (BufferedReader reader1 = new BufferedReader(new FileReader(detailPathOfB))) {
String line;
while ((line = reader1.readLine()) != null) {
resultListOfB.add(DetailDTO.convert(line));
}
}
......
} 大家可以發(fā)現(xiàn),讀取余額文件和剛剛的讀取明細(xì)文件很像,有一部分代碼是重復(fù)的,但是不能直接一下子抽個共同函數(shù)出來:
圖片
對了,convert方法是醬紫的哈:
public static BalanceDTO convert(String line){
BalanceDTO dto = new BalanceDTO();
String[] dataLine = line.split(",",-1);
dto.setBalance(dataLine[1]);
dto.setType(dataLine[2]);
......
return dto;
}大家可以發(fā)現(xiàn),就是一個返回類型,以及這個對應(yīng)類型的一個靜態(tài)convert方法不一致而已,如果是類型不一樣,我們可以使用泛型替代,如果是一個小的靜態(tài)方法不一致,我們則可以使用lambda函數(shù)式接口提取,因此可以抽這個這么一個公用方法吧:
public List readDataFromFile(String filePath, Function converter) throws IOException {
List result = new ArrayList<>();
try (BufferedReader reader = new BufferedReader(new FileReader(filePath))) {
String line;
while ((line = reader.readLine()) != null) {
result.add(converter.apply(line));
}
}
return result;
}
//余額讀取調(diào)用
List resultListOfA = readDataFromFile(balancePathOfA, BalanceDTO::convert);
//明細(xì)讀取調(diào)用
List resultList = readDataFromFile(detailPath, DetailDTO::convert); 平時我們用泛型+ Lambda表達(dá)式結(jié)合，去抽取公用方法，代碼就顯得高端大氣很多，對吧！
5. 繼承多態(tài).
在余額對比文件中，讀取完文件到內(nèi)存后，我們需要把通過某個唯一key關(guān)聯(lián)起來，即把List轉(zhuǎn)為Map，如下：
//對比明細(xì)
private void checkBalance(String balancePathOfA,String balancePathOfB ){
//讀取A端的文件
List resultListOfA = readDataFromFile(balancePathOfA, BalanceDTO::convert);
//讀取B端的文件
List resultListOfB = readDataFromFile(balancePathOfB, BalanceDTO::convert);
//A列表list轉(zhuǎn)化為Map
Map resultMapOfA = new HashMap<>()
for(BalanceDTO balance:resultListOfA){
resultMapOfA.add(balance.getType()+balance.getAccountNo(),balance);
} 一般來說，把兩個list轉(zhuǎn)化為Map，抽一個公用方法是不是就好了？比如說醬紫：
private Map convertListToMap(List list){
Map map = new HashMap<>()
for(BalanceDTO balance:list){
resultMapOfA.add(balance.getType()+balance.getAccountNo(),balance);
}
return map;
} 其實也行，但是其實可以更抽象一點。因為余額和明細(xì)對比都有l(wèi)ist轉(zhuǎn)map的需求，而且也是有共性的，只不過是轉(zhuǎn)化map的key和value的類型不一致而已。
圖片
我們仔細(xì)思考一下，value類型是不同類型（分別是BalanceDTO和DetailDTO），而key則是對應(yīng)對象的一個或者某幾個屬性連接起來的。對于不同類型，我們可以考慮泛型。對于余額和明細(xì)對象不同的key的話，我們則可以考慮繼承和多態(tài)，讓它們實現(xiàn)同一個接口就好啦。
我們可以使用繼承和多態(tài)，定義一個抽象類BaseKeyDTO，里面有個getKey的抽象方法,然后BalanceDTO 和DetailDTO都繼承它，實現(xiàn)各自getKey的方法，如下：
public abstract class BaseDTO {
abstract String getKey();
}
public class BalanceDTO extends BaseDTO {
@Override
String getKey() {
return type + accountNo;
}
}
public class DetailDTO extends BaseDTO {
@Override
String getKey() {
return bizSeq;
}最后，我們應(yīng)用繼承多態(tài)+擴(kuò)展泛型（
private static Map convertListToMap(List list) {
Map map = new HashMap<>();
for (T item : list) {
map.put(item.getKey(), item);
}
return map;
} 最后明細(xì)和余額對比，可以優(yōu)化成這樣，其實看起來已經(jīng)比較優(yōu)雅啦：
//對比明細(xì)
private void checkDetail(String detailPathOfA, String detailPathOfB) throws IOException {
//讀取A端明細(xì)的文件
List resultListOfA = readDataFromFile(detailPathOfA, DetailDTO::convert);
//讀取B端明細(xì)的文件
List resultListOfB = readDataFromFile(detailPathOfB, DetailDTO::convert);
//A列表轉(zhuǎn)化為Map
Map resultMapOfA = convertListToMap(resultListOfA);
//B列表轉(zhuǎn)化為Map
Map resultMapOfB = convertListToMap(resultListOfB);
//明細(xì)逐個對比
compareDifferent(resultMapOfA,resultMapOfB);
}
//對比余額
private void checkBalance(String balancePathOfA,String detailPathOfB) throws IOException {
//讀取A端余額的文件
List resultListOfA = readDataFromFile(balancePathOfA,BalanceDTO::convert);
//讀取B端余額的文件
List resultListOfB = readDataFromFile(detailPathOfB,BalanceDTO::convert);
//A余額列表轉(zhuǎn)化為Map
Map resultMapOfA = convertListToMap(resultListOfA);
//B余額列表轉(zhuǎn)化為Map
Map resultMapOfB = convertListToMap(resultListOfB);
//余額逐個對比
compareDifferent(resultMapOfA,resultMapOfB);
}
//對比也用泛型，抽一個公用的方法哈
private void compareDifferent(Map mapA, Map mapB) {
for (Map.Entry temp : mapA.entrySet()) {
if (mapB.containsKey(temp.getKey())) {
T dtoA = temp.getValue();
T dtoB = mapB.get(temp.getKey());
List resultList = compareObjects(dtoA, dtoB);
for (String tempStr : resultList) {
log.warn("{} is different,key:{}", tempStr, dtoA.getKey());
}
}
}
}
} 6. 模板方法
大家回頭細(xì)看，可以發(fā)現(xiàn)不管是明細(xì)還是余額對比，兩個方法很像，都是一個骨架流程來的：
- 讀取A、B端文件到內(nèi)存的兩個list
- 兩個list通過某個唯一key轉(zhuǎn)化為map
- 兩個map字段逐個對比
圖片
大家先回想一下模板方法模式：
定義了一個算法的骨架，將一些步驟延遲到子類中實現(xiàn)。這有助于避免在不同類中重復(fù)編寫相似的代碼。
頓時是不是就覺得這塊代碼還有優(yōu)化空間。
6.1 定義對比模板的骨架
我們可以嘗試這兩塊代碼再合并，用模板方法優(yōu)化它。我們先定義一個模板，然后模板內(nèi)定義它們骨架的流程，如下:
//聲明對比抽象模板
public abstract class AbstractCheckTemplate {
public void checkTemplate(String filePathA, String filePathB) throws IOException {
//從文件讀取為List
readDataFromFile(filePathA, filePathB);
//list轉(zhuǎn)化為Map
covertListToMap(resultListOfA, resultListOfB);
//比較
compareDifferent(mapA, mapB);
} 6.2 模板的方法逐步細(xì)化
因為readDataFromFile需要輸出兩個list，所以我們可以定義返回類型為Pair，代碼如下：
private Pair, List> readDataFromFile(String filePathA, String filePathB, Function converter) throws IOException {
//讀取A端余額的文件
List resultListOfA = readDataFromFile(filePathA, converter);
//讀取B端余額的文件
List resultListOfB = readDataFromFile(filePathB, converter);
return new Pair<>(resultListOfA, resultListOfB);
} 又因為這個函數(shù)式的轉(zhuǎn)化，是不同子類才能定下來的，我們就可以聲明個抽象方法convertLineToDTD，讓子類去實現(xiàn)。因此模板就變成這樣啦：
public abstract class AbstractCheckTemplate {
public void checkTemplate(String filePathA, String filePathB) throws IOException {
//從文件讀取為List
Pair, List> resultListPair = readDataFromFile(filePathA, filePathB, this::convertLineToDTD);
List resultListOfA = resultListPair.getKey();
List resultListOfB = resultListPair.getValue();
//list轉(zhuǎn)化為Map
covertListToMap(resultListOfA, resultListOfB);
//比較
compareDifferent(mapA, mapB);
}
//延遲到子類實現(xiàn)轉(zhuǎn)換為不同的DTO
protected abstract T convertLineToDTD(String line); 同理，還有兩個list轉(zhuǎn)化為兩個map再對比，我們可以聲明為這樣：
private Pair, Map> covertListToMap(List listA, List listB) {
return new Pair<>(convertListToMap(listA), convertListToMap(listB));
} 因此最終模板就是這樣啦：
@Slf4j
public abstract class AbstractCheckTemplate {
public void checkTemplate(String filePathA, String filePathB) throws IOException {
//從文件讀取為List
Pair, List> resultListPair = readDataFromFile(filePathA, filePathB, this::convertLineToDTD);
List resultListOfA = resultListPair.getKey();
List resultListOfB = resultListPair.getValue();
//list轉(zhuǎn)化為Map
Pair, Map> resultMapPair = covertListToMap(resultListOfA, resultListOfB);
Map mapA = resultMapPair.getKey();
Map mapB = resultMapPair.getValue();
//比較
compareDifferent(mapA, mapB);
}
protected abstract T convertLineToDTD(String line);
......此處省略公用的私有方法
} 6.3 不同對比子類
如果你是余額對比，那你聲明一個CheckBalanceStrategyServiceImpl去繼承抽象模板。
/**
* 余額對比策略
* 公眾號: 撿田螺的小男孩
*/
@Service
public class CheckBalanceStrategyServiceImpl extends AbstractCheckTemplate {
@Override
protected BalanceDTO convertLineToDTD(String line) {
return BalanceDTO.convert(line);
}
} 如果你是明細(xì)對比，那你聲明一個CheckDetailStrategyServiceImpl去繼承抽象模板。
/**
* 明細(xì)對比策略
* 關(guān)注公眾號: 撿田螺的小男孩
*/
@Service
public class CheckDetailStrategyServiceImpl extends AbstractCheckTemplate {
@Override
protected DetailDTO convertLineToDTD(String line) {
return DetailDTO.convert(line);
}
} 這兩個不同的子類，就像不同的策略，我們應(yīng)該都能嗅到策略模式的味道啦~
7. 工廠模式+ 模板方法 + 策略模式全家桶
有了明細(xì)對比、余額對比的模板，為了更方便調(diào)用，我們還可以定義一個校驗策略接口，然后交給spring工廠類，這樣更方便調(diào)用。其實日常開發(fā)中，這三種設(shè)計模式一般一起出現(xiàn)，非常實用:
我們先聲明一個校驗ICheckStrategy接口:
/**
* 關(guān)注公眾號: 撿田螺的小男孩
*/
public interface ICheckStrategy {
/**
* 對比校驗邏輯
* @param filePathA
* @param filePathB
* @throws IOException
*/
void check(String filePathA, String filePathB) throws IOException;
/**
* 校驗的類型，明細(xì)/余額
* @return
*/
CheckEnum getCheckEnum();
}然后，模板AbstractCheckTemplate實現(xiàn)ICheckStrategy接口。
public abstract class AbstractCheckTemplate implements ICheckStrategy { 接著，不同對比策略類CheckDetailStrategyServiceImpl 和CheckDetailStrategyServiceImpl映射對應(yīng)的對比校驗類型:
/**
* 明細(xì)對比策略
* 關(guān)注公眾號: 撿田螺的小男孩
*/
@Service
public class CheckDetailStrategyServiceImpl extends AbstractCheckTemplate {
@Override
protected DetailDTO convertLineToDTD(String line) {
return DetailDTO.convert(line);
}
@Override
public void check(String filePathA, String filePathB) throws IOException {
checkTemplate(filePathA, filePathB);
}
//對比校驗類型為：明細(xì)
@Override
public CheckEnum getCheckEnum() {
return CheckEnum.DETAIL_CHECK;
}
}
/**
* 余額對比策略
* 關(guān)注公眾號: 撿田螺的小男孩
*/
@Service
public class CheckBalanceStrategyServiceImpl extends AbstractCheckTemplate {
@Override
public void check(String filePathA, String filePathB) throws IOException {
checkTemplate(filePathA, filePathB);
}
//對比校驗類型為：余額
@Override
public CheckEnum getCheckEnum() {
return CheckEnum.BALANCE_CHECK;
}
@Override
protected BalanceDTO convertLineToDTD(String line) {
return BalanceDTO.convert(line);
}
} 最后一步，我們借助spring的生命周期，使用ApplicationContextAware接口，把對用的策略，初始化到map里面。然后對外提供checkCompare方法即可。讓調(diào)用者決定用哪一種對比，其實這算工廠模式思想，大家可以自己思考一下~
@Component
public class CheckCompareFactory implements ApplicationContextAware {
private final Map checkStrategyMap = new ConcurrentHashMap<>();
//把不同策略放到map
@Override
public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
Map tmepMap = applicationContext.getBeansOfType(ICheckStrategy.class);
tmepMap.values().forEach(strategyService -> checkStrategyMap.put(strategyService.getCheckEnum(), strategyService));
}
/**
* 直接調(diào)用這個方法即可
*/
public void checkCompare(CheckEnum checkEnum, String filePathA, String filePathB) throws IOException {
ICheckStrategy checkStrategy = checkStrategyMap.get(checkEnum);
checkStrategy.check(filePathA, filePathB);
}
} 最后
我是撿田螺的小男孩。本文介紹了：如何將一些通用的、用于優(yōu)化重復(fù)冗余代碼的技巧應(yīng)用到開發(fā)中。最終，我通過這些技巧將代碼優(yōu)化成一個通用模板。
新聞標(biāo)題：后端思維之通過層層代碼去重，我又搞了一個通用模板
網(wǎng)站鏈接：http://www.5511xx.com/article/ccsccoe.html
