利用愛(ài)星物聯(lián)服務(wù)腳手架實(shí)現(xiàn)定制服務(wù)

hello，小伙伴們，愛(ài)星物聯(lián)云平臺(tái)開(kāi)源已發(fā)布一段時(shí)間了，這篇文章《愛(ài)星物聯(lián)開(kāi)源版后臺(tái)定制開(kāi)發(fā)簡(jiǎn)介》介紹了愛(ài)星物聯(lián)開(kāi)源版的后臺(tái)定制開(kāi)發(fā)介紹。

可能有人會(huì)說(shuō)，這純理論的內(nèi)容，如果沒(méi)有深入去了解源代碼和相關(guān)工具，可能理解起來(lái)還是云里霧里，還是沒(méi)法下手定制開(kāi)發(fā)吧？

別急，理論指導(dǎo)實(shí)踐來(lái)了。本文介紹基于API腳手架和微服務(wù)腳手架構(gòu)建自定義的對(duì)應(yīng)服務(wù)，以及自定義服務(wù)怎么與愛(ài)星物聯(lián)IoT平臺(tái)服務(wù)進(jìn)行交互（內(nèi)容屬于下圖紅色線(xiàn)框部分）。

為了方便演示和理解，先以一個(gè)最簡(jiǎn)單的需求為例：

目標(biāo)：給平臺(tái)增加一個(gè)產(chǎn)品功能項(xiàng)告警配置功能。

場(chǎng)景設(shè)想：一個(gè)可充電電池版設(shè)備，當(dāng)電量過(guò)低時(shí)，需要在平臺(tái)端判定告警，而告警閾值因用戶(hù)而異，數(shù)值各有不同。

需求：實(shí)現(xiàn)告警配置(備注：判定告警和記錄告警的邏輯不在演示范圍)，后臺(tái)需提供告警閾值的增刪改查接口。

如何實(shí)現(xiàn)上述功能？按照下面的流程走一遍試試。

01創(chuàng)建數(shù)據(jù)庫(kù)、數(shù)據(jù)表

經(jīng)過(guò)簡(jiǎn)單梳理設(shè)備狀態(tài)的相關(guān)內(nèi)容，可在設(shè)備庫(kù)iot_device下創(chuàng)建數(shù)據(jù)表t_iot_device_alarm_config，數(shù)據(jù)表字段內(nèi)容整理如下：

其中dev_id、dpid兩列創(chuàng)建唯一索引，創(chuàng)建完成后可進(jìn)入下一步。

02數(shù)據(jù)庫(kù)操作代碼生成

在愛(ài)星物聯(lián)IoT平臺(tái)中，所有配置類(lèi)業(yè)務(wù)全部采用了MySQL數(shù)據(jù)庫(kù)。

Go語(yǔ)言的MySQL數(shù)據(jù)庫(kù)ORM相關(guān)的框架，開(kāi)源的有很多，功能基本相同。平臺(tái)使用了在國(guó)內(nèi)備受歡迎的數(shù)據(jù)庫(kù)ORM框架gorm及其配套的gen代碼生成工具。

gen工具有定制部分功能，主要是對(duì)特定列名、駝峰方式，MySQL部分?jǐn)?shù)據(jù)類(lèi)型轉(zhuǎn)換做了特定修改定制，代碼已開(kāi)源。

后臺(tái)的小伙伴們可以到https://github.com/ubases/gen找到定制的倉(cāng)庫(kù)。

這個(gè)工具有打包exe，建倉(cāng)庫(kù)代碼中的tool/mysql-to-model/gentool.exe，windows下的開(kāi)發(fā)者可以直接使用，linux下的開(kāi)發(fā)者可從源碼倉(cāng)庫(kù)中下載gen代碼編譯工具。

iot_device數(shù)據(jù)庫(kù)對(duì)應(yīng)的ORM包，在路徑iot_model/db_device下，進(jìn)入該目錄后，可看到有g(shù)entoo.bat文件，打開(kāi)該文件，內(nèi)容如下：

rem 生成整個(gè)庫(kù)

..\..\tool\mysql-to-model\gentool.exe -dsn "root:iLmz8sCXjkTYuh@tcp(192.168.5.56:3306)/iot_device?charset=utf8mb4&parseTime=True&loc=Local" -outPath orm -modelPkgName model

rem 生成單元測(cè)試加 -withUnitTest true

rem 生成某個(gè)表，后邊加 -tables {table name}

將其中的數(shù)據(jù)庫(kù)用戶(hù)名、密碼、IP、端口部分改成實(shí)際部署環(huán)境的參數(shù)，然后執(zhí)行g(shù)entoo.bat.如果環(huán)境和參數(shù)配置都正確，那么會(huì)在model和orm子目錄下，會(huì)生成很多go文件。仔細(xì)觀(guān)察，會(huì)發(fā)現(xiàn)，這兩個(gè)子目錄新生成1個(gè)名為

t_iot_device_alarm_config.gen.go的文件，這個(gè)2個(gè)文件就是我們新增加的表t_iot_device_alarm_config的所有公共代碼。

其中model目錄的t_iot_device_alarm_config.gen.go里邊包含t_iot_device_alarm_config表對(duì)應(yīng)go結(jié)構(gòu)體及映射關(guān)系.

orm目錄的t_iot_device_alarm_config.gen.go里邊包含該表的常用增刪改查操作方法。

Model目錄下的model包比較好理解，orm目錄下的orm包，每個(gè)表的操作方法一樣，不過(guò)只需要熟悉掌握其中的1個(gè)表的所有方案，即可掌握orm包下所有方法的用法。

03創(chuàng)建自定義服務(wù)骨架

在了解愛(ài)星物聯(lián)API和微服務(wù)腳手架的源代碼結(jié)構(gòu)后，開(kāi)源倉(cāng)庫(kù)中的iot_demo_api_service是API的腳手架，自定義API服務(wù)可以基于這個(gè)腳手架進(jìn)行開(kāi)發(fā)。

倉(cāng)庫(kù)中的iot_demo_service是微服務(wù)的腳手架。

愛(ài)星物聯(lián)IoT平臺(tái)有一條未明確說(shuō)明的規(guī)則，Web、APP、小程序等的入口都是API類(lèi)的服務(wù)，該類(lèi)API服務(wù)對(duì)外提供http/websocket+json接口；API調(diào)用內(nèi)部服務(wù)以及內(nèi)部服務(wù)之間，全部是基于grpc+protobuf的接口。

為了演示需要，按照這個(gè)規(guī)則，基于iot_demo_api_service和iot_demo_service服務(wù)分別拷貝整個(gè)工程目錄到新的目錄，并改名為iot_my_api_service和iot_my_service（正式服務(wù)定制時(shí)請(qǐng)用正常名稱(chēng)，這里演示，取名隨意），修改后的代碼結(jié)構(gòu)見(jiàn)下圖（左側(cè)是腳手架，右側(cè)是自定義的API和微服務(wù)）。

拷貝完成后，開(kāi)始進(jìn)行包名和代碼修改。

進(jìn)入iot_my_api_service目錄，挨個(gè)將go文件import的所有包名中的包含的iot_demo_api_service全部替換為iot_my_api_service。進(jìn)入iot_my_service目錄，挨個(gè)將go文件import的所有包名中的包含的iot_demo_service全部替換為iot_my_service。改為后，進(jìn)行簡(jiǎn)單的編譯，確保編譯通過(guò)。

04微服務(wù)和API代碼生成和完善

開(kāi)源倉(cāng)庫(kù)中，類(lèi)似iot_{XXX}_service的目錄中，都是一個(gè)個(gè)服務(wù)。這些服務(wù)結(jié)構(gòu)看起來(lái)是不是很整齊的樣子，那是因?yàn)榇蟛糠衷鰟h改查之類(lèi)的代碼、部分實(shí)體、及RPC接口都是用工具生成，上一步用到的腳手架部分代碼也是這樣生成的。

代碼生成工具在tool/mysql-to-service路徑下。具體的用法可以參考README.md文件。

修改config.yaml配置文件

執(zhí)行g(shù)en.bat

打開(kāi)gen.bat文件，并修改為如下內(nèi)容：

后邊--tableName 后邊加表名，也就是第一步創(chuàng)建的表的名字。

修改后運(yùn)行，就會(huì)在gen目錄下，生成如下目錄結(jié)構(gòu)的文件。

注意到上面有個(gè)proto目錄，工具生成了2個(gè)文件：

iot_device_alarm_config_model.gen.proto

iot_device_alarm_config_service.gen.proto。這2個(gè)文件里邊有定義grpc接口和消息結(jié)構(gòu)。

本次生成的代碼，感興趣的開(kāi)發(fā)者們可以仔細(xì)看看代碼結(jié)構(gòu)，這里不貼代碼介紹了。

執(zhí)行g(shù)engo.bat

這一步依賴(lài)上一步生成proto文件，這一步的目標(biāo)是利用protoc工具將proto文件生成go語(yǔ)言代碼。

這一步比較簡(jiǎn)單，不需要修改gengo.bat文件，執(zhí)行執(zhí)行即可。執(zhí)行完成后，會(huì)在protosService下生成對(duì)應(yīng)的go代碼，這個(gè)例子生成了4個(gè)文件：

iot_device_alarm_config_model.gen.pb.go

iot_device_alarm_config_model.gen.pb.micro.go

iot_device_alarm_config_service.gen.pb.go

iot_device_alarm_config_service.gen.pb.micro.go

將這4個(gè)文件拷貝到iot_proto/protos/protosService路徑下。

代碼拷貝

將gen目錄下的convert、entitys、handler、service目錄整體拷貝到iot_my_service下，覆蓋原來(lái)的文件。覆蓋后的目錄文件結(jié)構(gòu)如下所示：

將entitys下的文件iot_device_alarm_config_entitys.gen.go拷貝到iot_my_api_service/controls/system/entitys下（這里演示放到了system模塊下，實(shí)際定制開(kāi)發(fā)中請(qǐng)根據(jù)實(shí)際需要放到controls下的子模塊中）。

完成iot_my_service服務(wù)

●打開(kāi)iot_my_service/handler/register_handler.go文件，把剛生成的handler注冊(cè)進(jìn)去。

●進(jìn)入bin/conf/open，復(fù)制一份iot_demo_service.yml，將其改名為iot_my_service.yml，并修改配置文件中的內(nèi)容。重點(diǎn)是logfile和database下的內(nèi)容，注意修改正確。

●打開(kāi)源代碼

iot_my_service/config/config.go，修改配置文件為iot_my_service.yml。

●原來(lái)demo中的表config_dict_type在iot_config數(shù)據(jù)庫(kù)，現(xiàn)在切換到了iot_device數(shù)據(jù)庫(kù)，因此，需要?jiǎng)h除掉原來(lái)config_dict_type相關(guān)的內(nèi)容。

●進(jìn)入

iot_common/iotconst/service_name.go，給服務(wù)定義一個(gè)常量IOT_MY_SERVICE，并取個(gè)服務(wù)名，其它服務(wù)會(huì)根據(jù)這個(gè)服務(wù)名去微服務(wù)注冊(cè)中心找到地址信息。并在main.go中將服務(wù)名修改為新取得名稱(chēng)，即將iotconst.IOT_DEMO_SERVICE修改為iotconst.IOT_MY_SERVICE。

●至此iot_my_service全部改造完成，可直接編譯運(yùn)行。

完成iot_my_api_service服務(wù)

●定義rpc客戶(hù)端。進(jìn)入rpc目錄打開(kāi)globalService.go，修改為如下內(nèi)容：

●進(jìn)入iot_my_api_service/controls下，實(shí)現(xiàn)HTTP接口，這塊目前沒(méi)有代碼生成工具生成，可以仿照basedata開(kāi)頭的文件，實(shí)現(xiàn)自己的api和service。代碼中可以使用上一步創(chuàng)建的客戶(hù)端接口，類(lèi)似調(diào)用本地函數(shù)類(lèi)似，調(diào)用接口方法。關(guān)于這塊的代碼生成，后續(xù)可能會(huì)推出。

●打開(kāi)iot_my_api_service/router/router.go，注冊(cè)新實(shí)現(xiàn)的模塊的路由。如果共用demo提供的system則不需要重復(fù)注冊(cè)。

●仿照iot_my_service添加配置文件。

●修改config.go，將配置文件名稱(chēng)改為第4步添加的配置文件。

●至此iot_my_api_service全部改造完成，可直接編譯運(yùn)行。

經(jīng)過(guò)以上步驟就完成了微服務(wù)和API服務(wù)代碼的基本定制，通過(guò)API接口調(diào)用微服務(wù)實(shí)現(xiàn)告警配置的增刪改查。其中基于腳手架的配置步驟有點(diǎn)多，但不復(fù)雜，熟練了這個(gè)過(guò)程是很快的，各位開(kāi)發(fā)者小伙伴來(lái)試試吧~

審核編輯 黃宇