需求分析

我們有一個應用平臺需要和某特殊伺服器對接，實現對特殊伺服器的一些操作以及狀態資訊的讀取。但是該伺服器由多個廠商完成，且每個廠商的實現方式不同，因此不能通過應用平臺逐一實現每個廠商的介面呼叫。我們考慮在特殊伺服器端部署一個通用操作介面服務，應用平臺僅僅與該介面通訊，而具體的命令下發則由該通用操作介面服務實施。此時，僅需在介面服務專案中實現不同廠商的命令實現即可。該介面服務的需求如下：

• 介面服務與應用平臺的通訊標準化並實施通訊加密。
• 應用無需考慮伺服器硬體情況，僅需與介面服務通訊即可完成所有功能對接。
• 介面服務前端接收應用平臺請求資料，後端向伺服器傳送命令並接收結果。
• 介面服務的後端應根據功能需求指定規範，並要求廠商實現這些規範功能。
• 介面服務的後端應支援根據不同伺服器型別靈活配置，實現模組化，並可以靈活配置和替換。
• 介面服務後端模組應與前端請求解耦，支援廠商自行開發後端實現模組。
• 介面服務在啟動時應該實現對裝置的認證，未通過認證的裝置不允許對外提供服務。

程式設計

總體實際

我們計劃將後端介面服務設計為REST風格的微服務，因此採用Spring boot作為框架基礎。同時考慮到前後解耦的需求，我們將專案拆分為前後端兩個模組。如下所示：
nmi為專案名:network management interface

--> nmi (父專案)
|-->nmi-front(前端模組)
|-->nmi-core(後端模組)

如上所示，整體專案由MAVEN管理，將專案拆分後，nmi-core以jar包形式引入nmi-front中。我們在nmi-core中制定好介面interface，不同廠商的則可以在該模組模板的基礎上開發各自對應的nmi-core.jar。這樣在最終部署時即可通過替換nmi-core.jar實現對不同裝置的定製。

MAVEN構建

nmi父專案

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation
 
="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>org.wsy</groupId>
    <artifactId>nmi</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>pom</packaging>
    <name>nmi</name>
    <description>network management interface</description>
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.wsy</groupId>
                <artifactId>nmi-core</artifactId>
                <type>jar</type>
                <scope>compile</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>
    <modules>
        <module>nmi-core</module>
        <module>nmi-front</module>
    </modules>
</project>

nmi-front模組

<?xml version="1.0"?>
<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <modelVersion>4.0.0</modelVersion>
  <parent>
    <groupId>org.wsy</groupId>
    <artifactId>nmi</artifactId>
    <version>0.0.1-SNAPSHOT</version>
  </parent>
  <artifactId>nmi-front</artifactId>
  <name>nmi-front</name>
  <url>http://maven.apache.org</url>
  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  </properties>
  <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <version>1.3.3.RELEASE</version>
        </dependency>
        <!-- nmi core -->
        <!-- <dependency>
            <groupId>com.rails</groupId>
            <artifactId>nmi-core</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency> -->
        <dependency>
            <groupId>org.wsy</groupId>
            <artifactId>nmi-core</artifactId>
            <version>0.0.1-SNAPSHOT</version>
            <scope>system</scope>
            <systemPath>${project.basedir}/lib/nmi-core.jar</systemPath>
        </dependency>   
        <!-- nmi core -->
    </dependencies>
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

nmi-core模組

<?xml version="1.0"?>
<project
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"
    xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.wsy</groupId>
        <artifactId>nmi</artifactId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>
    <artifactId>nmi-core</artifactId>
    <name>nmi-core</name>
    <url>http://maven.apache.org</url>
    <packaging>jar</packaging>
    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>
    <build>
        <finalName>nmi-core</finalName>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

程式碼設計

模組結構

core

core僅需負責硬體命令的下發和裝置認證，如有需要新增日誌功能。因此包結構如下：
|>org.wsy.nmi.core
|--|>org.wsy.nmi.core.command
|--|--|>ICommand.java
|--|--|>ACommand.java
|--|>org.wsy.nmi.core.device
|--|--|>IDevice.java
|--|--|>ADevice.java
|--|>org.wsy.nmi.core.log
|--|--|>logger.java

其中ICommand.java 介面定義了所有裝置應該實現的操作。IDevice.java 介面定義了裝置認證相關的操作。

ACommand.java 以及 ADevice.java 為某廠商(如:A)的具體介面實現。

front

專案結構

nmi-front 模組帶有主要的Spring boot特性，有Application啟動器，controller等模組。結構如下

|>org.wsy.nmi.front
|--|>org.wsy.nmi.front.controllers
|--|--|>RequestController.java
|--|>org.wsy.nmi.front.module
|--|--|>org.wsy.nmi.front.module.config
|--|--|--|>Config.java
|--|--|>org.wsy.nmi.front.module.factory
|--|--|--|>CommandServiceFactory.java
|--|--|--|>DeviceAuthFactory.java
|--|--|>org.wsy.nmi.front.module.task
|--|--|--|>InitTask.java
|--|--|>org.wsy.nmi.front.module.cache
|--|--|--|>GlobalCache.java
|--|>Application.java

主要程式碼說明

Application.java(sping boot 啟動器)

@SpringBootApplication
//需要支援外部配置properties檔案
@EnableConfigurationProperties({ DeviceConfig.class })
public class App {
    public static void main(String[] args) {
        SpringApplication.run(App.class, args);
    }
}

Config.java(配置對映)

//讀取指定專案
@ConfigurationProperties(prefix="device")
public class DeviceConfig {
    private String mac;
    private String infname;
    private String deviceauth;
    private String commandservice;
    //....以下省略

InitTask.java(專案啟動後的動作)

附：其中的GlobalCache，DeviceAuthFactory，CommandServiceFactory的具體實現在後邊標出。

//這部分程式碼主要負責專案啟動完畢後的裝置認證等工作
@Component
public class PostTask {
    DeviceAuth auth = null;
    @Autowired
    DeviceConfig config;
    @PostConstruct
    public void init() {
        System.out.println("init finished");
        try {
            //從properties檔案讀取具體實現的Class路徑，在後邊通過反射載入
            String deviceAuthClass = config.getDeviceauth();
            String commandService = config.getCommandservice();
            //根據配置載入模組
            System.out.println("\n********  registering module  ********");

            try {
                //載入裝置認證模組
                auth = DeviceAuthFactory.getInstance().build(deviceAuthClass).getAuth();
                GlobalCache.getInstance().setDeviceAuthState(auth.deviceAuth());

                if (GlobalCache.getInstance().isDeviceAuthState()) {
                    //如果認證通過則繼續載入命令執行模組
                    System.out.println("device auth success!");
                    System.out.println("loading command service ...");
                    GlobalCache.getInstance().setCommandService(
                            CommandServiceFactory.getInstance().build(commandService).getCommandService());
                } else {
                    //如果認證過程失敗則標記為認證失敗
                    GlobalCache.getInstance().setDeviceAuthState(false);
                    System.out.println("device auth fail!");
                }

            } catch (Exception e) {
                //如果裝置認證模組載入失敗則標記為認證失敗
                System.out.println("init fail, error:"+e);
                GlobalCache.getInstance().setDeviceAuthState(false);
            }

        } catch (Exception e) {
            System.out.println("auth err");
        }
    }

}

CommandServiceFactory(命令實現載入器)

通過單例模式實現，僅需一次載入即可，DeviceAuthFactory的載入機制相同，這裡就不贅述了。

public class CommandServiceFactory {
    private volatile static CommandServiceFactory  instance;
    private String className;
    private CommandService service;
        public static CommandServiceFactory getInstance(){
        if (instance== null) {
            synchronized(CommandServiceFactory.class){
                if(instance == null){
                    instance = new CommandServiceFactory();
                }
            }
        }
        return instance;
    }
    private CommandServiceFactory(){ }
    //通過反射動態載入
    public CommandServiceFactory build(String className) throws Exception{
        this.className = className;
        service = (CommandService) Class.forName(className).newInstance();
        return this;
    }
    public CommandService getCommandService() {
        return service;
    }
    public String getClassName(){
        return className;
    }
}

GlobalCache.java(全域性變數)

同樣以單例形式實現，用於儲存認證結果，裝置資訊等。
具體實現略。

程式效果

配置截圖

以下均是假設配置

執行效果

模組存在並裝置認證成功

假設nmi-core.jar中確實包含配置檔案中的實現類，則順利載入模組並執行認證過程。

啟動、認證過程

以下為認證通過的啟動過程截圖：

可以看到模組順利載入，並認證成功。

介面呼叫

模組載入成功同時認證成功後，可以正常呼叫介面。其中返回的”this is a A command service”即為假設A裝置廠商的自定義服務返回的串。

模組存在但是認證失敗

啟動、認證過程

圖上可以看出，已經順利載入模組（XXDevice），但是裝置認證失敗了。

介面呼叫

可以看到介面是不能順利呼叫的。

模組載入異常

比如配置檔案錯誤，廠商並未實現介面，則無法順利載入模組，也會造成認證失敗。

啟動、認證過程

可以看出，模組並未順利載入(class not found err)，因此無法認證裝置。

介面呼叫

和上文的認證失敗是相同的，因此不在列舉。

總結

• Spring boot 實現REST風格的微服務
• 實現了介面微服務的前後分離解耦
• 通過反射機制按照配置動態載入介面實現
• 設計並實現了裝置認證流程