實用的SpringBoot生成License方案

王子發表於2021-06-15

 

前言

License指的是版權許可證,當我們開發完系統後,如果不想讓使用者一直白嫖使用,比如說按時間續費,License的作用就有了。

我們可以給系統指定License的有效期,控制系統的可用時間。

那麼對於SpringBoot專案,如何增加License呢?接下來王子給大家帶來一套解決方案。(當然實現方式不止一種)

 

生成License

工具已經封裝好,小夥伴們可以直接下載使用:https://gitee.com/lm970585581/spring-boot2-license

下載後開啟cloud-license-serve專案直接啟動即可。

然後呼叫專案的獲取資訊介面:http://localhost:9081/license/getServerInfos?osName=windows

會得到類似如下結果,分別代表ip地址、mac地址、cpu序號、主機板序號。

{
    "ipAddress": [
        "192.168.80.1",
        "192.168.220.1"
    ],
    "macAddress": [
        "01-51-56-C0-00-01",
        "00-52-56-C0-00-08",
        "BC-54-2D-DF-69-FC"
    ],
    "cpuSerial": "BFECFBFF000806EC",
    "mainBoardSerial": "L1HF16301D5"
}

使用JDK自帶的 keytool 工具生成公私鑰證書庫:

假如我們設定公鑰庫密碼為:public_password1234,私鑰庫密碼為:private_password1234,則生成命令如下:

上述命令執行完成之後,會在當前路徑下生成三個檔案,分別是:privateKeys.keystore、publicCerts.keystore、certfile.cer。其中檔案certfile.cer不再需要可以刪除,檔案privateKeys.keystore用於當前的 ServerDemo 專案給客戶生成license檔案,而檔案publicCerts.keystore則隨應用程式碼部署到客戶伺服器,使用者解密license檔案並校驗其許可資訊。

最後我們再生成license,呼叫介面地址為:http://localhost:9081/license/generateLicense

呼叫的引數是一個json引數,格式如下:

{
    "subject": "license_demo",
    "privateAlias": "privateKey",
    "keyPass": "private_password1234",
    "storePass": "public_password1234",
    "licensePath": "C:/Users/zifangsky/Desktop/license_demo/license.lic",
    "privateKeysStorePath": "C:/Users/zifangsky/Desktop/license_demo/privateKeys.keystore",
    "issuedTime": "2018-07-10 00:00:01",
    "expiryTime": "2019-12-31 23:59:59",
    "consumerType": "User",
    "consumerAmount": 1,
    "description": "這是證書描述資訊",
    "licenseCheckModel": {
        "ipAddress": ["192.168.245.1", "10.0.5.22"],
        "macAddress": ["00-50-56-C0-00-01", "50-7B-9D-F9-18-41"],
        "cpuSerial": "BFEBFBFF000406E3",
        "mainBoardSerial": "L1HF65E00X9"
    }
}

如果請求成功,那麼最後會在 licensePath 引數設定的路徑生成一個 license.lic 的檔案,這個檔案就是給客戶部署程式碼的伺服器許可檔案。

 

使用License

如果小夥伴們按照上文的步驟一步一步的跟著實現,我們已經獲得了license.lic,接下來就是把license使用到我們自己的專案中了。

cloud-license-client就是引入專案的一個例子,開啟可以直接使用。

引入自己的專案只需將以下檔案匯入

並配置好攔截器LicenseCheckInterceptor就可以使用了。配置方法在InterceptorConfig類中,可以參考。

這裡需要注意的是使用license需要兩個檔案:license.lic,publicCerts.keystore

演示專案配置的路徑是絕對路徑,一般我們會配置相對路徑,把兩個檔案放到專案下,配置位置在LicenseCheckListener類中

修改如下部分改為相對路徑讀取就可以了

 

這裡就不演示如何修改了,因為修改起來很容易。

還需要注意一點:

對於LicenseCheckModel,LicenseCreatorParam兩個類,引入到自己的客戶端後一定要保證包名與生成license時的包名一致,不然會導致序列化失敗的問題。

 

總結

好了,到這裡本文的分享就結束了,本文分享的其實是License的使用說明,並沒有帶大家閱讀原始碼去看原理,感興趣的小夥伴可以自行閱讀一下專案原始碼,也很容易看懂哦。

 

往期文章推薦:

JVM專欄

訊息中介軟體專欄

併發程式設計專欄

 

相關文章