接口規范文檔

遼寧省國土空間規劃“一張圖”實施監督信息系統接口規范

一、技術路線：

1.1. spring cloud

1.1.1. 技術描述

微服務：就是把一個單體項目,拆分為多個微服務,每個微服務可以獨立技術選型,獨立開發,獨立部署,獨立運維.并且多個服務相互協調,相互配合,最終完成用戶的價值.

Spring cloud是一個基于Spring Boot實現的服務治理工具包，在微服務架構中用于管理和協調服務的。它利用Spring Boot的開發便利性巧妙地簡化了分布式系統基礎設施的開發，如服務發現注冊、配置中心、消息總線、負載均衡、斷路器、數據監控等，都可以用Spring Boot的開發風格做到一鍵啟動和部署，架構圖如1.1.1。

1.1.2.技術特點

優點：

1）通過分解巨大單體式應用為多個服務方法解決了復雜性問題，每個微服務相對較小。

2）每個單體應用不局限于固定的技術棧，開發者可以自由選擇開發技術，提供API服務。

3）每個微服務獨立的開發，部署。

4）單一職責功能，每個服務都很簡單，只關注于一個業務功能。

5）易于規模化開發，多個開發團隊可以并行開發，每個團隊負責一項服務。

6）改善故障隔離。一個服務宕機不會影響其他的服務。

缺點：

1）測試工作更加困難。

2）需要采用服務間的通訊機制。

3）很難在不采用分布式事務的情況下跨服務實現功能。

4）跨服務實現要求功能要求團隊之間的緊密協作 。

1.1.1

1.2. spring boot

1.2.1. 技術描述

Spring Boot是由Pivotal團隊提供的全新框架，其設計目的是用來簡化新Spring應用的初始搭建以及開發過程。該框架使用了特定的方式來進行配置（約定優于配置），從而使開發人員不再需要定義樣板化的配置。通過這種方式，Spring Boot致力于在蓬勃發展的快速應用開發領域成為領導者

1.2.3. 技術特點

優點：

1）創建獨立的Spring applications

2）能夠使用內嵌的Tomcat, Jetty or Undertow，

3）不需要部署war

4）提供定制化的starter poms來簡化maven配置（gradle相同）

5）追求極致的自動配置Spring

6）提供一些生產環境的特性，比如特征指標，健康檢查和外部配置。

1.3. rabbitMq

1.3.1. 技術描述

AMQP，即Advanced Message Queuing Protocol，高級消息隊列協議，是應用層協議的一個開放標準，為面向消息的中間件設計。消息中間件主要用于組件之間的解耦，消息的發送者無需知道消息使用者的存在，反之亦然。

AMQP的主要特征是面向消息、隊列、路由（包括點對點和發布/訂閱）、可靠性、安全。

RabbitMQ是一個開源的AMQP實現，服務器端用Erlang語言編寫，支持多種客戶端，如：Python、Ruby、.NET、Java、JMS、C、PHP、ActionScript、XMPP、STOMP等，支持AJAX。用于在分布式系統中存儲轉發消息，在易用性、擴展性、高可用性等方面表現不俗。

1.3.2. 技術特點

優點：

1）支持集群化、高可用部署架構、消息高可靠支持

2）復雜系統的解耦；

3）復雜鏈路的異步調用

4）瞬時高峰的削峰處理。

缺點：

1）系統可用性降低

2）系統復雜度提高

3）一致性問題

1.4. apollo

1.4.1. 技術描述

因為如今程序功能越來越復雜，程序的配置日益增多：各種功能的開關、參數配置、服務器地址、數據庫鏈接等。對于配置的期望值越來越高：配置修改后實時生效、灰度發布、分環境、分集群管理配置、完善的權限、審核機制等。所以傳統的配置文件越來越無法滿足開發人員的需求。于是就有了 Apollo。

Apollo（阿波羅）是攜程框架部門研發的分布式配置中心，能夠集中化管理應用不同環境、不同集群的配置，配置修改后能夠實時推送到應用端，并且具備規范的權限、流程治理等特性，適用于微服務配置管理場景。

1.4.3. 技術特點

優點：

1）同意管理不同環境、不同集群的配置

2）配置修改實時生效（熱發布）

3）版本發布管理--所有配置都有版本概念，便于配置的回滾

4）提供java和.net原生客戶端，方便應用集成

5）提供開放平套API

1.5. web socket

1.5.1. 技術描述

眾所周知，在WebSocket出現之前，很多網站為了實現推送技術，所用的技術都是 Ajax 輪詢。輪詢是在特定的的時間間隔（如每1秒），由瀏覽器對服務器發出HTTP請求，然后由服務器返回最新的數據給客戶端的瀏覽器。這種傳統的模式帶來很明顯的缺點，即瀏覽器需要不斷的向服務器發出請求，然而HTTP請求可能包含較長的頭部，其中真正有效的數據可能只是很小的一部分，顯然這樣會浪費很多的帶寬等資源。而基于WebSocket 協議實現的客戶端和服務器之簡的通信，能更好的節省服務器資源和帶寬，并且能夠更實時地進行通訊。

WebSocket是基于TCP的一種新的網絡協議，并在2011年被IETF定為標準的全雙工通信協議，它實現了客戶端與服務器全雙工通信。

WebSocket 使得客戶端和服務器之間的數據交換變得更加簡單，允許服務端主動向客戶端推送數據。在 WebSocket API 中，瀏覽器和服務器只需要完成一次握手，兩者之間就直接可以創建持久性的連接，并進行雙向數據傳輸。

1.5.2. 技術特點

優點：

1）建立在 TCP 協議之上，服務器端的實現比較容易。

2）與 HTTP 協議有著良好的兼容性。默認端口也是80和443，并且握手階段采用 HTTP 3）協議，因此握手時不容易屏蔽，能通過各種 HTTP 代理服務器。

4）數據格式比較輕量，性能開銷小，通信高效。

5）可以發送文本，也可以發送二進制數據。

6）沒有同源限制，客戶端可以與任意服務器通信。

1.6. 文件

1.6.1. 技術描述

文件接口定義了服務端與客戶端文件存放路徑、文件名命名規則和文件格式，并開放相應的讀/寫操作權限。同時能夠處理壓縮包并處理壓縮包中文件。

1.6.2. 技術特點

優點：

1）實時、高效和安全可靠地傳送批量數據。

2）斷點續傳功能。

3）數據壓縮傳輸。

4）傳輸過程中的差錯控制。

二、基本要求：

在當前的大環境下，健壯的系統應有

1、強大的功能，充足滿足用戶的需求。

2、精準的數據流轉，避免數據的丟失，錯誤。

2、快速的迭代架構，能夠及時對需求的開發和迭代。

3、接口應實現對外部系統的接入提供企業級的支持，在系統的高并發和大容量的基礎上提供安全可靠的接入。

4、提供完善的信息安全機制，以實現對信息的全面保護，保證系統的正常運行，應防止大量訪問，以及大量占用資源的情況發生，保證系統的健壯性。

5、提供有效的系統的可監控機制，使得接口的運行情況可監控，便于及時發現錯誤及排除故障。

6、保證在充分利用系統資源的前提下，實現系統平滑的移植和擴展，同時在系統并發增加時提供系統資源的動態擴展，以保證系統的穩定性。

7、在進行擴容、新業務擴展時，應能提供快速、方便和準確的實現方式。

三、安全要求：

1）票據驗證：為了保證系統的安全運行，各種接口方式都應該保證其接入的安全性。通過鑒權實現接口接入的安全，每個請求頭都需要攜帶服務器發放的票據，只有票據通過驗證才能調用接口。

2）信息加密：所有敏感信息都需要通過加密后傳遞，防止中途被截取，從而暴露用戶私密信息。

3）入侵檢測：使用nginx通過限流、緩存、黑白名單等方式對請求進行攔截，從而檢測到非法的入侵。

4）sql注入：嚴格檢查sql語法，防止sql注入帶來的風險。

5）ip記錄：存放每個訪問者的ip地址，同時可以對每個在線用戶進行操作。

6）日志記錄：對請求進行記錄，從而對數據流向能夠充足的掌握。

四、調用方式：

接口基本采用了同步請求/應答方式、異步請求/應答方式、會話方式、廣播通知方式、事件訂閱方式、可靠消息傳輸方式、文件傳輸等通訊方式：

1、同步請求/應答方式：客戶端向服務器端發送服務請求，客戶端阻塞等待服務器端返回處理結果；例：普通的調用接口方式。

2、異步請求/應答方式：客戶端向服務器端發送服務請求，與同步方式不同的是，在此方式下，服務器端處理請求時，客戶端繼續運行；當服務器端處理結束時返回處理結果；例：通過架構的異步注解調用。

3、會話方式：客戶端與服務器端建立連接后，可以多次發送或接收數據，同時存儲信息的上下文關系；例：通過web socket方式建立前后臺連接。

4、廣播通知方式：由服務器端主動向客戶端以單個或批量方式發出未經客戶端請求的廣播或通知消息，客戶端可在適當的時候檢查是否收到消息并定義收到消息后所采取的動作；

例：通過web socket通知所有用戶消息。

5、事件訂閱方式：客戶端可事先向服務器端訂閱自定義的事件，當這些事件發生時，服務器端通知客戶端事件發生，客戶端可采取相應處理。事件訂閱方式使客戶端擁有了個性化的事件觸發功能，極大方便了客戶端及時響應所訂閱的事件；例：通過審批流進行訂閱管理。

6、文件傳輸：客戶端和服務器端通過文件的方式來傳輸消息，并采取相應處理；

7、可靠消息傳輸：在接口通訊中，基于消息的傳輸處理方式，除了可采用以上幾種通訊方式外，還可采用可靠消息傳輸方式，即通過存儲隊列方式，客戶端和服務器端來傳輸消息，采取相應處理。例：通過rabbitmq建立信息的存儲隊列。

五、功能服務內容：

六、數據服務內容：

1）精準的數據流轉，簡單明了的數據流程。

2）簡潔的數據處理，包括模糊查詢，篩選，排序，分類，匯總等功能。

3）可視化的數據顯示，通過餅圖，曲線圖，柱狀圖等多種呈現方式，使數據更加豐滿。

4）數據權限，區域權限保證在數據在系統中的安全性，使用戶各司其職。

5）異步，消息隊列，多線程等技術保證了數據響應時間，大大提升用戶體驗。

6）數據可以通過模型，excel，數據庫，系統等多個途徑收集。

7）強大的數據日志，可以快速定位責任人。

七、接口技術優勢

1）使用spring boot,spring cloud套件，作為市面上最火熱的技術，spring開源文檔數量多，功能強大，開發周期短，滿足敏捷開發的理念。

2）多種接口調用方式，滿足絕大部分場景。

3）多種安全策略，保證數據安全。

4）通過mq等技術保證接口的響應速度，提高用戶體驗。

5）完備的接口文檔，簡單易懂的出入參。

Spring 微服務

版權聲明：本文內容由網絡用戶投稿，版權歸原作者所有，本站不擁有其著作權，亦不承擔相應法律責任。如果您發現本站中有涉嫌抄襲或描述失實的內容，請聯系我們jiasou666@gmail.com 處理，核實后本網站將在24小時內刪除侵權內容。