重學 Java 設計模式：實戰外觀模式「基於SpringBoot開發門面模式中間件，統一控制接口白名單場景」

時間  2020-06-13
標籤 java 設計 模式 實戰 外觀 基於 springboot 開發 門面 中間件 統一 控制 口白 名單 場景 欄目 Java 简体版
原文   原文鏈接

做者：小傅哥
博客：https://bugstack.cnhtml

沉澱、分享、成長，讓本身和他人都能有所收穫！😄

1、前言

你感覺到的容易，必定有人爲你承擔不容易前端

這句話更像是描述生活的，許許多多的磕磕絆絆總有人爲你提供躲雨的屋檐和避風的港灣。其實編程開發的團隊中也同樣有人只負責CRUD中的簡單調用，去使用團隊中高級程序員開發出來的核心服務和接口。這樣的編程開發對於初期剛進入程序員行業的小夥伴來講鍛鍊鍛鍊仍是不錯的，但隨着開發的日子愈來愈久一直作這樣的事情就很可貴到成長，也想努力的去作一些更有難度的承擔，以此來加強我的的技術能力。java

沒有最好的編程語言，語言只是工具程序員

刀槍棍棒、斧鉞鉤叉、包子油條、盒子麻花，是語言。五郎八卦棍、十二路彈腿、洪家鐵線拳，是設計。記得葉問裏有一句臺詞是：金山找：今天我北方拳術，輸給你南方拳術了。葉問：你錯了，不是南北拳的問題，是你的問題。因此當你編程開發寫的久了，就不會再特別在乎用的語言，而是爲目標服務，用最好的設計能力也就是編程的智慧作出作最完美的服務。這也就是編程人員的價值所在！web

設計與反設計以及過渡設計spring

設計模式是解決程序中不合理、不易於擴展、不易於維護的問題，也是幹掉大部分ifelse的利器，在咱們經常使用的框架中基本都會用到大量的設計模式來構建組件，這樣也能方便框架的升級和功能的擴展。但！若是不能合理的設計以及亂用設計模式，會致使整個編程變得更加複雜難維護，也就是咱們常說的；反設計、過渡設計。而這部分設計能力也是從實踐的項目中獲取的經驗，不斷的改造優化摸索出的最合理的方式，應對當前的服務體量。編程

2、開發環境

  1. JDK 1.8
  2. Idea + Maven
  3. SpringBoot 2.1.2.RELEASE
  4. 涉及工程三個，能夠經過關注公衆號：bugstack蟲洞棧，回覆源碼下載獲取(打開獲取的連接，找到序號18)
工程 描述
itstack-demo-design-10-00 場景模擬工程；模擬一個提供接口服務的SpringBoot工程
itstack-demo-design-10-01 使用一坨代碼實現業務需求
itstack-demo-design-10-02 經過設計模式開發爲中間件，包裝通用型核心邏輯

3、外觀模式介紹

外觀模式，圖片來自 refactoringguru.cn

外觀模式也叫門面模式，主要解決的是下降調用方的使用接口的複雜邏輯組合。這樣調用方與實際的接口提供方提供方提供了一箇中間層，用於包裝邏輯提供API接口。有些時候外觀模式也被用在中間件層，對服務中的通用性複雜邏輯進行中間件層包裝，讓使用方能夠只關心業務開發。設計模式

那麼這樣的模式在咱們的所見產品功能中也常常遇到，就像幾年前咱們註冊一個網站時候每每要添加不少信息，包括；姓名、暱稱、手機號、QQ、郵箱、住址、單身等等，但如今註冊成爲一個網站的用戶只須要一步便可，不管是手機號仍是微信也都提供了這樣的登陸服務。而對於服務端應用開發來講之前是提供了一個整套的接口，如今註冊的時候並無這些信息，那麼服務端就須要進行接口包裝，在前端調用註冊的時候服務端獲取相應的用戶信息(從各個渠道)，若是獲取不到會讓用戶後續進行補全(營銷補全信息給獎勵)，以此來拉動用戶的註冊量和活躍度。api

4、案例場景模擬

場景模擬；全部服務添加白名單校驗

在本案例中咱們模擬一個將全部服務接口添加白名單的場景tomcat

在項目不斷壯大發展的路上，每一次發版上線都須要進行測試，而這部分測試驗證通常會進行白名單開量或者切量的方式進行驗證。那麼若是在每個接口中都添加這樣的邏輯，就會很是麻煩且不易維護。另外這是一類具有通用邏輯的共性需求，很是適合開發成組件，以此來治理服務，讓研發人員更多的關心業務功能開發。

通常狀況下對於外觀模式的使用一般是用在複雜或多個接口進行包裝統一對外提供服務上，此種使用方式也相對簡單在咱們日常的業務開發中也是最經常使用的。你可能常常聽到把這兩個接口包裝一下，但在本例子中咱們把這種設計思路放到中間件層，讓服務變得能夠統一控制。

1. 場景模擬工程

itstack-demo-design-10-00
└── src
    ├── main
    │   ├── java
    │   │   └── org.itstack.demo.design
    │   │       ├── domain
    │   │       │    └── UserInfo.java
    │   │       ├── web    
    │   │       │    └── HelloWorldController.java
    │   │       └── HelloWorldApplication.java
    │   └── resources    
    │       └── application.yml    
    └── test
        └── java
            └── org.itstack.demo.test
                └── ApiTest.java
  • 這是一個SpringBoot的HelloWorld工程，在工程中提供了查詢用戶信息的接口HelloWorldController.queryUserInfo，爲後續擴展此接口的白名單過濾作準備。

2. 場景簡述

2.1 定義基礎查詢接口

@RestController
public class HelloWorldController {

    @Value("${server.port}")
    private int port;

    /**
     * key：須要從入參取值的屬性字段，若是是對象則從對象中取值，若是是單個值則直接使用
     * returnJson：預設攔截時返回值，是返回對象的Json
     *
     * http://localhost:8080/api/queryUserInfo?userId=1001
     * http://localhost:8080/api/queryUserInfo?userId=小團團
     */
    @RequestMapping(path = "/api/queryUserInfo", method = RequestMethod.GET)
    public UserInfo queryUserInfo(@RequestParam String userId) {
        return new UserInfo("蟲蟲:" + userId, 19, "天津市南開區旮旯衚衕100號");
    }

}
  • 這裏提供了一個基本的查詢服務，經過入參userId，查詢用戶信息。後續就須要在這裏擴展白名單，只有指定用戶才能夠查詢，其餘用戶不能查詢。

2.2 設置Application啓動類

@SpringBootApplication
@Configuration
public class HelloWorldApplication {

    public static void main(String[] args) {
        SpringApplication.run(HelloWorldApplication.class, args);
    }

}
  • 這裏是通用的SpringBoot啓動類。須要添加的是一個配置註解@Configuration，爲了後續能夠讀取白名單配置。

5、用一坨坨代碼實現

通常對於此種場景最簡單的作法就是直接修改代碼

累加if塊幾乎是實現需求最快也是最慢的方式，快是修改當前內容很快，慢是若是同類的內容幾百個也都須要如此修改擴展和維護會愈來愈慢。

1. 工程結構

itstack-demo-design-10-01
└── src
    └── main
        └── java
            └── org.itstack.demo.design
                └── HelloWorldController.java
  • 以上的實現是模擬一個Api接口類，在裏面添加白名單功能，但相似此類的接口會有不少都須要修改，因此這也是不推薦使用此種方式的重要緣由。

2. 代碼實現

public class HelloWorldController {

    public UserInfo queryUserInfo(@RequestParam String userId) {

        // 作白名單攔截
        List<String> userList = new ArrayList<String>();
        userList.add("1001");
        userList.add("aaaa");
        userList.add("ccc");
        if (!userList.contains(userId)) {
            return new UserInfo("1111", "非白名單可訪問用戶攔截！");
        }

        return new UserInfo("蟲蟲:" + userId, 19, "天津市南開區旮旯衚衕100號");
    }

}
  • 在這裏白名單的代碼佔據了一大塊，但它又不是業務中的邏輯，而是由於咱們上線過程當中須要作的開量前測試驗證。
  • 若是你平常對待此類需求常常是這樣開發，那麼能夠按照此設計模式進行優化你的處理方式，讓後續的擴展和摘除更加容易。

6、外觀模式重構代碼

接下來使用外觀器模式來進行代碼優化，也算是一次很小的重構。

此次重構的核心是使用外觀模式也能夠說門面模式，結合SpringBoot中的自定義starter中間件開發的方式，統一處理全部須要白名單的地方。

後續接下來的實現中，會涉及的知識；

  1. SpringBoot的starter中間件開發方式。
  2. 面向切面編程和自定義註解的使用。
  3. 外部自定義配置信息的透傳，SpringBoot與Spring不一樣，對於此類方式獲取白名單配置存在差別。

1. 工程結構

itstack-demo-design-10-02
└── src
    ├── main
    │   ├── java
    │   │   └── org.itstack.demo.design.door
    │   │       ├── annotation
    │   │       │    └── DoDoor.java    
    │   │       ├── config
    │   │       │    ├── StarterAutoConfigure.java
    │   │       │    ├── StarterService.java
    │   │       │    └── StarterServiceProperties.java
    │   │       └── DoJoinPoint.java
    │   └── resources    
    │       └── META_INF
    │           └── spring.factories
    └── test
        └── java
            └── org.itstack.demo.test
                └── ApiTest.java

門面模式模型結構

門面模式模型結構

  • 以上是外觀模式的中間件實現思路，右側是爲了獲取配置文件，左側是對於切面的處理。
  • 門面模式能夠是對接口的包裝提供出接口服務，也能夠是對邏輯的包裝經過自定義註解對接口提供服務能力。

2. 代碼實現

2.1 配置服務類

public class StarterService {

    private String userStr;

    public StarterService(String userStr) {
        this.userStr = userStr;
    }

    public String[] split(String separatorChar) {
        return StringUtils.split(this.userStr, separatorChar);
    }

}
  • 以上類的內容較簡單只是爲了獲取配置信息。

2.2 配置類註解定義

@ConfigurationProperties("itstack.door")
public class StarterServiceProperties {

    private String userStr;

    public String getUserStr() {
        return userStr;
    }

    public void setUserStr(String userStr) {
        this.userStr = userStr;
    }

}
  • 用於定義好後續在 application.yml 中添加 itstack.door 的配置信息。

2.3 自定義配置類信息獲取

@Configuration
@ConditionalOnClass(StarterService.class)
@EnableConfigurationProperties(StarterServiceProperties.class)
public class StarterAutoConfigure {

    @Autowired
    private StarterServiceProperties properties;

    @Bean
    @ConditionalOnMissingBean
    @ConditionalOnProperty(prefix = "itstack.door", value = "enabled", havingValue = "true")
    StarterService starterService() {
        return new StarterService(properties.getUserStr());
    }

}
  • 以上代碼是對配置的獲取操做，主要是對註解的定義；@Configuration、@ConditionalOnClass、@EnableConfigurationProperties，這一部分主要是與SpringBoot的結合使用。

2.4 切面註解定義

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface DoDoor {

    String key() default "";

    String returnJson() default "";

}
  • 定義了外觀模式門面註解，後續就是此註解添加到須要擴展白名單的方法上。
  • 這裏提供了兩個入參，key：獲取某個字段例如用戶ID、returnJson：肯定白名單攔截後返回的具體內容。

2.5 白名單切面邏輯

@Aspect
@Component
public class DoJoinPoint {

    private Logger logger = LoggerFactory.getLogger(DoJoinPoint.class);

    @Autowired
    private StarterService starterService;

    @Pointcut("@annotation(org.itstack.demo.design.door.annotation.DoDoor)")
    public void aopPoint() {
    }

    @Around("aopPoint()")
    public Object doRouter(ProceedingJoinPoint jp) throws Throwable {
        //獲取內容
        Method method = getMethod(jp);
        DoDoor door = method.getAnnotation(DoDoor.class);
        //獲取字段值
        String keyValue = getFiledValue(door.key(), jp.getArgs());
        logger.info("itstack door handler method：{} value：{}", method.getName(), keyValue);
        if (null == keyValue || "".equals(keyValue)) return jp.proceed();
        //配置內容
        String[] split = starterService.split(",");
        //白名單過濾
        for (String str : split) {
            if (keyValue.equals(str)) {
                return jp.proceed();
            }
        }
        //攔截
        return returnObject(door, method);
    }

    private Method getMethod(JoinPoint jp) throws NoSuchMethodException {
        Signature sig = jp.getSignature();
        MethodSignature methodSignature = (MethodSignature) sig;
        return getClass(jp).getMethod(methodSignature.getName(), methodSignature.getParameterTypes());
    }

    private Class<? extends Object> getClass(JoinPoint jp) throws NoSuchMethodException {
        return jp.getTarget().getClass();
    }

    //返回對象
    private Object returnObject(DoDoor doGate, Method method) throws IllegalAccessException, InstantiationException {
        Class<?> returnType = method.getReturnType();
        String returnJson = doGate.returnJson();
        if ("".equals(returnJson)) {
            return returnType.newInstance();
        }
        return JSON.parseObject(returnJson, returnType);
    }

    //獲取屬性值
    private String getFiledValue(String filed, Object[] args) {
        String filedValue = null;
        for (Object arg : args) {
            try {
                if (null == filedValue || "".equals(filedValue)) {
                    filedValue = BeanUtils.getProperty(arg, filed);
                } else {
                    break;
                }
            } catch (Exception e) {
                if (args.length == 1) {
                    return args[0].toString();
                }
            }
        }
        return filedValue;
    }

}
  • 這裏包括的內容較多，核心邏輯主要是；Object doRouter(ProceedingJoinPoint jp)，接下來咱們分別介紹。

@Pointcut("@annotation(org.itstack.demo.design.door.annotation.DoDoor)")

定義切面，這裏採用的是註解路徑，也就是全部的加入這個註解的方法都會被切面進行管理。

getFiledValue

獲取指定key也就是獲取入參中的某個屬性，這裏主要是獲取用戶ID，經過ID進行攔截校驗。

returnObject

返回攔截後的轉換對象，也就是說當非白名單用戶訪問時則返回一些提示信息。

doRouter

切面核心邏輯，這一部分主要是判斷當前訪問的用戶ID是否白名單用戶，若是是則放行jp.proceed();，不然返回自定義的攔截提示信息。

3. 測試驗證

這裏的測試咱們會在工程：itstack-demo-design-10-00中進行操做，經過引入jar包，配置註解的方式進行驗證。

3.1 引入中間件POM配置

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>itstack-demo-design-10-02</artifactId>
</dependency>
  • 打包中間件工程，給外部提供jar包服務

3.2 配置application.yml

# 自定義中間件配置
itstack:
  door:
    enabled: true
    userStr: 1001,aaaa,ccc #白名單用戶ID，多個逗號隔開
  • 這裏主要是加入了白名單的開關和白名單的用戶ID，逗號隔開。

3.3 在Controller中添加自定義註解

/**
 * http://localhost:8080/api/queryUserInfo?userId=1001
 * http://localhost:8080/api/queryUserInfo?userId=小團團
 */
@DoDoor(key = "userId", returnJson = "{\"code\":\"1111\",\"info\":\"非白名單可訪問用戶攔截！\"}")
@RequestMapping(path = "/api/queryUserInfo", method = RequestMethod.GET)
public UserInfo queryUserInfo(@RequestParam String userId) {
    return new UserInfo("蟲蟲:" + userId, 19, "天津市南開區旮旯衚衕100號");
}
  • 這裏核心的內容主要是自定義的註解的添加@DoDoor，也就是咱們的外觀模式中間件化實現。
  • key：須要從入參取值的屬性字段，若是是對象則從對象中取值，若是是單個值則直接使用。
  • returnJson：預設攔截時返回值，是返回對象的Json。

3.4 啓動SpringBoot

.   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::        (v2.1.2.RELEASE)

2020-06-11 23:56:55.451  WARN 65228 --- [           main] ion$DefaultTemplateResolverConfiguration : Cannot find template location: classpath:/templates/ (please add some templates or check your Thymeleaf configuration)
2020-06-11 23:56:55.531  INFO 65228 --- [           main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat started on port(s): 8080 (http) with context path ''
2020-06-11 23:56:55.533  INFO 65228 --- [           main] o.i.demo.design.HelloWorldApplication    : Started HelloWorldApplication in 1.688 seconds (JVM running for 2.934)
  • 啓動正常，SpringBoot已經啓動能夠對外提供服務。

3.5 訪問接口接口測試

白名單用戶訪問

http://localhost:8080/api/queryUserInfo?userId=1001

{"code":"0000","info":"success","name":"蟲蟲:1001","age":19,"address":"天津市南開區旮旯衚衕100號"}
  • 此時的測試結果正常，能夠拿到接口數據。

非白名單用戶訪問

http://localhost:8080/api/queryUserInfo?userId=小團團

{"code":"1111","info":"非白名單可訪問用戶攔截！","name":null,"age":null,"address":null}
  • 此次咱們把userId換成小團團，此時返回的信息已是被攔截的信息。而這個攔截信息正式咱們自定義註解中的信息：@DoDoor(key = "userId", returnJson = "{\"code\":\"1111\",\"info\":\"非白名單可訪問用戶攔截！\"}")

7、總結

  • 以上咱們經過中間件的方式實現外觀模式，這樣的設計能夠很好的加強代碼的隔離性，以及複用性，不只使用上很是靈活也下降了每個系統都開發這樣的服務帶來的風險。
  • 可能目前你看這只是很是簡單的白名單控制，是否須要這樣的處理。但每每一個小小的開始會影響着後續無限的擴展，實際的業務開發每每也要複雜的不少，不可能如此簡單。於是使用設計模式來讓代碼結構更加乾淨整潔。
  • 不少時候不是設計模式沒有用，而是本身編程開發經驗不足致使即便學了設計模式也很難駕馭。畢竟這些知識都是通過一些實際操做提煉出來的精華，但若是你能夠按照本系列文章中的案例方式進行學習實操，仍是能夠加強這部分設計能力的。

8、推薦閱讀

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程