Compare commits

...

2 Commits

Author SHA1 Message Date
douxu f48807e5e5 optimize measurement link api 2025-12-08 17:01:24 +08:00
douxu 3f70be0d1c fix bug of new version of measurement recommend api 2025-12-06 18:32:00 +08:00
15 changed files with 287 additions and 155 deletions

115
api.md
View File

@ -1,115 +0,0 @@
# 接口协议
## 实时数据接口示例
### 开启实时数据的订阅
```json
{
"action": "start",
"components": [
{
"interval": "1",
"targets": [
"grid1.zone1.station1.ns1.tag1.transformfeeder1_220.I_A_rms",
"grid1.zone1.station1.ns1.tag1.transformfeeder1_220.I_B_rms"
]
},
{
"interval": "2",
"targets": [
"grid1.zone1.station1.ns1.tag1.transformfeeder1_220.I_C_rms"
]
}
]
}
```
### 实时数据订阅成功
```json
{
"targets": [
{
"id": "grid1.zone1.station1.ns1.tag1.transformfeeder1_220.I_A_rms",
"code": "1001",
"msg": "subscription success"
},
{
"id": "grid1.zone1.station1.ns1.tag1.transformfeeder1_220.I_B_rms",
"code": "1002",
"msg": "subscription failed"
}
]
}
```
### 实时数据的返回
```json
{
"targets": [
{
"id": "grid1.zone1.station1.ns1.tag1.transformfeeder1_220.I_A_rms",
"datas": [
{
"time": 1736305467506000000,
"value": 1
},
{
"time": 1736305467506000000,
"value": 1
}
]
},
{
"id": "grid1.zone1.station1.ns1.tag1.transformfeeder1_220.I_B_rms",
"datas": [
{
"time": 1736305467506000000,
"value": 1
},
{
"time": 1736305467506000000,
"value": 1
}
]
}
]
}
```
### 结束实时数据的获取
```json
{
"action": "stop",
"targets": [
"grid1.zone1.station1.ns1.tag1.transformfeeder1_220.I_A_rms",
"grid1.zone1.station1.ns1.tag1.transformfeeder1_220.I_B_rms"
]
}
```
## 实时数据状态值
| 动作描述 | 示例值 |
| :--- | :--- |
| 订阅成功 | 1001 |
| 订阅失败 | 1002 |
| 实时数据返回成功 | 1003 |
| 实时数据返回失败 | 1004 |
| 取消订阅成功 | 1005 |
| 取消订阅失败 | 1006 |
## 实时数据标志
### 以设备语言中的type作为区分方式
| 标志描述 | 示例值 |
| :--- | :--- |
| 遥测 | TE |
| 遥信 | TI |
| 遥控 | TC |
| 遥调 | TA |
| 定值 | - |

View File

@ -50,5 +50,8 @@ var ErrChanIsNil = errors.New("this channel is nil")
// ErrConcurrentModify define error of concurrent modification detected
var ErrConcurrentModify = errors.New("existed concurrent modification risk")
// ErrUnsupportedAction define error of unsupported real time data monitor action
var ErrUnsupportedAction = errors.New("unsupported real time data monitor action")
// ErrUnsupportedSubAction define error of unsupported real time data subscription action
var ErrUnsupportedSubAction = errors.New("unsupported real time data subscription action")
// ErrUnsupportedLinkAction define error of unsupported measurement link process action
var ErrUnsupportedLinkAction = errors.New("unsupported rmeasurement link process action")

View File

@ -29,3 +29,8 @@ const (
ChannelSuffixUBC = "UBC"
ChannelSuffixUCA = "UCA"
)
const (
// MaxIdentifyHierarchy define max data indentify syntax hierarchy
MaxIdentifyHierarchy = 7
)

View File

@ -38,3 +38,10 @@ const (
// RedisSpecCompTagMeasSetKey define redis set key which store all measurement keys under specific component tag
RedisSpecCompTagMeasSetKey = "%s_measurement_keys"
)
const (
// SearchLinkAddAction define search link add action
SearchLinkAddAction = "add"
// SearchLinkDelAction define search link del action
SearchLinkDelAction = "del"
)

View File

@ -0,0 +1,50 @@
// Package database define database operation functions
package database
import (
"context"
"fmt"
"strconv"
"time"
"modelRT/common/errcode"
"modelRT/network"
"modelRT/orm"
"github.com/gofrs/uuid"
"gorm.io/gorm"
)
// CreateMeasurement define create measurement info of the circuit diagram into DB
func CreateMeasurement(ctx context.Context, tx *gorm.DB, measurementInfo network.MeasurementCreateInfo) (string, error) {
cancelCtx, cancel := context.WithTimeout(ctx, 5*time.Second)
defer cancel()
globalUUID, err := uuid.FromString(measurementInfo.UUID)
if err != nil {
return "", fmt.Errorf("format uuid from string type failed:%w", err)
}
measurement := orm.Measurement{
Tag: "",
Name: "",
Type: -1,
Size: -1,
DataSource: nil,
EventPlan: nil,
BayUUID: globalUUID,
ComponentUUID: globalUUID,
Op: -1,
Ts: time.Now(),
}
result := tx.WithContext(cancelCtx).Create(&measurement)
if result.Error != nil || result.RowsAffected == 0 {
err := result.Error
if result.RowsAffected == 0 {
err = fmt.Errorf("%w:please check insert component slice", errcode.ErrInsertRowUnexpected)
}
return "", fmt.Errorf("insert component info failed:%w", err)
}
return strconv.FormatInt(measurement.ID, 10), nil
}

View File

@ -64,7 +64,7 @@ func bulkInsertAllHierarchySets(ctx context.Context, rdb *redis.Client) error {
return fmt.Errorf("dynamic hierarchy insertion failed: %w", err)
}
log.Println("bulk insertion complete.")
log.Println("bulk insertion complete")
return nil
}

View File

@ -14,6 +14,7 @@ import (
// RedisSet defines the encapsulation struct of redis hash type
type RedisSet struct {
ctx context.Context
key string
rwLocker *locker.RedissionRWLocker
storageClient *redis.Client
logger *zap.Logger
@ -24,6 +25,7 @@ func NewRedisSet(ctx context.Context, setKey string, lockLeaseTime uint64, needR
token := ctx.Value("client_token").(string)
return &RedisSet{
ctx: ctx,
key: setKey,
rwLocker: locker.InitRWLocker(setKey, token, lockLeaseTime, needRefresh),
storageClient: GetRedisClientInstance(),
logger: logger.GetLoggerInstance(),
@ -31,34 +33,34 @@ func NewRedisSet(ctx context.Context, setKey string, lockLeaseTime uint64, needR
}
// SADD define func of add redis set by members
func (rs *RedisSet) SADD(setKey string, members ...interface{}) error {
func (rs *RedisSet) SADD(members ...any) error {
err := rs.rwLocker.WLock(rs.ctx)
if err != nil {
logger.Error(rs.ctx, "lock wLock by setKey failed", "set_key", setKey, "error", err)
logger.Error(rs.ctx, "lock wLock by setKey failed", "set_key", rs.key, "error", err)
return err
}
defer rs.rwLocker.UnWLock(rs.ctx)
err = rs.storageClient.SAdd(rs.ctx, setKey, members).Err()
err = rs.storageClient.SAdd(rs.ctx, rs.key, members).Err()
if err != nil {
logger.Error(rs.ctx, "add set by memebers failed", "set_key", setKey, "members", members, "error", err)
logger.Error(rs.ctx, "add set by memebers failed", "set_key", rs.key, "members", members, "error", err)
return err
}
return nil
}
// SREM define func of remove the specified members from redis set by key
func (rs *RedisSet) SREM(setKey string, members ...interface{}) error {
func (rs *RedisSet) SREM(members ...any) error {
err := rs.rwLocker.WLock(rs.ctx)
if err != nil {
logger.Error(rs.ctx, "lock wLock by setKey failed", "set_key", setKey, "error", err)
logger.Error(rs.ctx, "lock wLock by setKey failed", "set_key", rs.key, "error", err)
return err
}
defer rs.rwLocker.UnWLock(rs.ctx)
count, err := rs.storageClient.SRem(rs.ctx, setKey, members).Result()
count, err := rs.storageClient.SRem(rs.ctx, rs.key, members).Result()
if err != nil || count != int64(len(members)) {
logger.Error(rs.ctx, "rem members from set failed", "set_key", setKey, "members", members, "error", err)
logger.Error(rs.ctx, "rem members from set failed", "set_key", rs.key, "members", members, "error", err)
return fmt.Errorf("rem members from set failed:%w", err)
}
@ -66,27 +68,27 @@ func (rs *RedisSet) SREM(setKey string, members ...interface{}) error {
}
// SMembers define func of get all memebers from redis set by key
func (rs *RedisSet) SMembers(setKey string) ([]string, error) {
func (rs *RedisSet) SMembers() ([]string, error) {
err := rs.rwLocker.RLock(rs.ctx)
if err != nil {
logger.Error(rs.ctx, "lock rLock by setKey failed", "set_key", setKey, "error", err)
logger.Error(rs.ctx, "lock rLock by setKey failed", "set_key", rs.key, "error", err)
return nil, err
}
defer rs.rwLocker.UnRLock(rs.ctx)
result, err := rs.storageClient.SMembers(rs.ctx, setKey).Result()
result, err := rs.storageClient.SMembers(rs.ctx, rs.key).Result()
if err != nil {
logger.Error(rs.ctx, "get all set field by hash key failed", "set_key", setKey, "error", err)
logger.Error(rs.ctx, "get all set field by hash key failed", "set_key", rs.key, "error", err)
return nil, err
}
return result, nil
}
// SIsMember define func of determine whether an member is in set by key
func (rs *RedisSet) SIsMember(setKey string, member interface{}) (bool, error) {
result, err := rs.storageClient.SIsMember(rs.ctx, setKey, member).Result()
func (rs *RedisSet) SIsMember(member any) (bool, error) {
result, err := rs.storageClient.SIsMember(rs.ctx, rs.key, member).Result()
if err != nil {
logger.Error(rs.ctx, "get all set field by hash key failed", "set_key", setKey, "error", err)
logger.Error(rs.ctx, "get all set field by hash key failed", "set_key", rs.key, "error", err)
return false, err
}
return result, nil

View File

@ -20,7 +20,8 @@ type RedisZSet struct {
}
// NewRedisZSet define func of new redis zset instance
func NewRedisZSet(ctx context.Context, key string, token string, lockLeaseTime uint64, needRefresh bool) *RedisZSet {
func NewRedisZSet(ctx context.Context, key string, lockLeaseTime uint64, needRefresh bool) *RedisZSet {
token := ctx.Value("client_token").(string)
return &RedisZSet{
ctx: ctx,
rwLocker: locker.InitRWLocker(key, token, lockLeaseTime, needRefresh),

View File

@ -38,14 +38,14 @@ func MeasurementGetHandler(c *gin.Context) {
return
}
zset := diagram.NewRedisZSet(c, request.MeasurementToken, clientToken, 0, false)
zset := diagram.NewRedisZSet(c, request.MeasurementToken, 0, false)
points, err := zset.ZRANGE(request.MeasurementToken, 0, -1)
if err != nil {
logger.Error(c, "failed to get measurement data from redis", "measurement_token", request.MeasurementToken, "error", err)
c.JSON(http.StatusOK, network.FailureResponse{
Code: http.StatusInternalServerError,
Msg: err.Error(),
Payload: map[string]interface{}{
Payload: map[string]any{
"measurement_id": request.MeasurementID,
"measurement_token": request.MeasurementToken,
},
@ -60,7 +60,7 @@ func MeasurementGetHandler(c *gin.Context) {
c.JSON(http.StatusOK, network.FailureResponse{
Code: http.StatusBadRequest,
Msg: err.Error(),
Payload: map[string]interface{}{
Payload: map[string]any{
"measurement_id": request.MeasurementID,
"measurement_token": request.MeasurementToken,
"measurement_value": points,
@ -72,7 +72,7 @@ func MeasurementGetHandler(c *gin.Context) {
c.JSON(http.StatusOK, network.SuccessResponse{
Code: http.StatusOK,
Msg: "success",
Payload: map[string]interface{}{
Payload: map[string]any{
"measurement_id": request.MeasurementID,
"measurement_token": request.MeasurementToken,
"measurement_info": measurementInfo,

136
handler/mesurement_link.go Normal file
View File

@ -0,0 +1,136 @@
// Package handler provides HTTP handlers for various endpoints.
package handler
import (
"errors"
"fmt"
"net/http"
"modelRT/constants"
"modelRT/database"
"modelRT/diagram"
"modelRT/logger"
"modelRT/network"
"github.com/gin-gonic/gin"
)
// MeasurementLinkHandler defines the measurement link process api
func MeasurementLinkHandler(c *gin.Context) {
var request network.MeasurementLinkRequest
clientToken := c.GetString("client_token")
if clientToken == "" {
err := constants.ErrGetClientToken
logger.Error(c, "failed to get client token from context", "error", err)
c.JSON(http.StatusOK, network.FailureResponse{
Code: http.StatusBadRequest,
Msg: err.Error(),
})
return
}
if err := c.ShouldBindJSON(&request); err != nil {
logger.Error(c, "failed to unmarshal measurement create request", "error", err)
c.JSON(http.StatusOK, network.FailureResponse{
Code: http.StatusBadRequest,
Msg: "Invalid request body format: " + err.Error(),
})
return
}
var err error
pgClient := database.GetPostgresDBClient()
measurementID := request.MeasurementID
action := request.Action
measurementInfo, err := database.QueryMeasurementByID(c, pgClient, measurementID)
if err != nil {
logger.Error(c, "failed to query measurement info by measurement id from postgres", "meauserement_id", measurementID, "error", err)
c.JSON(http.StatusOK, network.FailureResponse{
Code: http.StatusInternalServerError,
Msg: "failed to query measurement info record: " + err.Error(),
Payload: map[string]any{
"id": measurementID,
"action": action,
},
})
return
}
componentInfo, err := database.QueryComponentByUUID(c, pgClient, measurementInfo.ComponentUUID)
if err != nil {
logger.Error(c, "failed to query component info by component uuid from postgres", "component_uuid", measurementInfo.ComponentUUID, "error", err)
c.JSON(http.StatusOK, network.FailureResponse{
Code: http.StatusInternalServerError,
Msg: "failed to query component info record: " + err.Error(),
Payload: map[string]any{
"id": measurementID,
"action": action,
},
})
return
}
allMeasSet := diagram.NewRedisSet(c, constants.RedisAllMeasTagSetKey, 0, false)
compMeasLinkKey := fmt.Sprintf(constants.RedisSpecCompTagMeasSetKey, componentInfo.Tag)
compMeasLinkSet := diagram.NewRedisSet(c, compMeasLinkKey, 0, false)
switch action {
case constants.SearchLinkAddAction:
err1 := allMeasSet.SADD(measurementInfo.Tag)
err2 := compMeasLinkSet.SADD(measurementInfo.Tag)
err = processActionError(err1, err2, action)
if err != nil {
logger.Error(c, "add measurement link process operation failed", "measurement_id", measurementID, "action", action, "error", err)
}
case constants.SearchLinkDelAction:
err1 := allMeasSet.SREM(measurementInfo.Tag)
err2 := compMeasLinkSet.SREM(measurementInfo.Tag)
err = processActionError(err1, err2, action)
if err != nil {
logger.Error(c, "del measurement link process operation failed", "measurement_id", measurementID, "action", action, "error", err)
}
default:
err = constants.ErrUnsupportedLinkAction
logger.Error(c, "unsupport measurement link process action", "measurement_id", measurementID, "action", action, "error", err)
}
if err != nil {
c.JSON(http.StatusOK, network.FailureResponse{
Code: http.StatusBadRequest,
Msg: err.Error(),
Payload: map[string]any{
"measurement_id": request.MeasurementID,
"action": request.Action,
},
})
return
}
logger.Info(c, "process measurement link success", "measurement_id", measurementID, "action", request.Action)
c.JSON(http.StatusOK, network.SuccessResponse{
Code: http.StatusOK,
Msg: "measurement link process success",
Payload: map[string]any{
"measurement_id": measurementID,
"action": request.Action,
},
})
}
func processActionError(err1, err2 error, action string) error {
var err error
if err1 != nil && err2 != nil {
err = errors.Join(err1, err2)
err = fmt.Errorf("process measurement link failed, allMeasSet %s operation and compMeasLinkSet %s operation failed: %w", action, action, err)
} else if err1 != nil {
err = fmt.Errorf("process measurement link failed: allMeasSet %s operation failed: %w", action, err1)
} else {
err = fmt.Errorf("process measurement link failed: compMeasLinkSet %s operation: %w", action, err2)
}
return err
}

View File

@ -216,7 +216,7 @@ func RealTimeSubHandler(c *gin.Context) {
})
return
default:
err := fmt.Errorf("%w: request action is %s", constants.ErrUnsupportedAction, request.Action)
err := fmt.Errorf("%w: request action is %s", constants.ErrUnsupportedSubAction, request.Action)
logger.Error(c, "unsupported action of real time data subscription request", "error", err)
requestTargetsCount := processRealTimeRequestCount(request.Measurements)
results := processRealTimeRequestTargets(request.Measurements, requestTargetsCount, err)

View File

@ -220,7 +220,7 @@ func main() {
go func() {
<-done
if err := server.Shutdown(context.Background()); err != nil {
logger.Error(ctx, "ShutdownServerError", "err", err)
logger.Error(ctx, "shutdown serverError", "err", err)
}
}()
@ -229,10 +229,10 @@ func main() {
if err != nil {
if err == http.ErrServerClosed {
// the service receives the shutdown signal normally and then closes
logger.Info(ctx, "Server closed under request")
logger.Info(ctx, "server closed under request")
} else {
// abnormal shutdown of service
logger.Error(ctx, "Server closed unexpected", "err", err)
logger.Error(ctx, "server closed unexpected", "err", err)
}
}
}

View File

@ -50,7 +50,7 @@ func RedisSearchRecommend(ctx context.Context, input string) ([]string, bool, er
}
// start grid tagname fuzzy search
recommends, err := runFuzzySearch(ctx, gridSearchInput, inputSliceLen)
recommends, err := runFuzzySearch(ctx, gridSearchInput, "", inputSliceLen)
if err != nil {
logger.Error(ctx, "fuzzy search failed for level 1", "search_input", gridSearchInput, "error", err)
return []string{}, false, err
@ -141,9 +141,10 @@ func getSpecificKeyByLength(inputLen int, input string) string {
}
// handleLevelFuzzySearch define func to process recommendation logic for specific levels(level >= 2)
func handleLevelFuzzySearch(ctx context.Context, rdb *redis.Client, level int, keySetKey string, inputSlice []string) ([]string, bool, error) {
searchInputIndex := level - 1
func handleLevelFuzzySearch(ctx context.Context, rdb *redis.Client, hierarchy int, keySetKey string, inputSlice []string) ([]string, bool, error) {
searchInputIndex := hierarchy - 1
searchInput := inputSlice[searchInputIndex]
searchPrefix := strings.Join(inputSlice[0:searchInputIndex], ".")
if searchInput == "" {
var specificalKey string
@ -152,11 +153,11 @@ func handleLevelFuzzySearch(ctx context.Context, rdb *redis.Client, level int, k
specificalKey = inputSlice[specificalKeyIndex]
}
allResults, isFuzzy, err := getKeyBySpecificsLevel(ctx, rdb, level, specificalKey)
allResults, isFuzzy, err := getKeyBySpecificsLevel(ctx, rdb, hierarchy, specificalKey)
if err != nil {
return []string{}, false, err
}
recommandResults := combineQueryResultByInput(level, inputSlice, allResults)
recommandResults := combineQueryResultByInput(hierarchy, inputSlice, allResults)
return recommandResults, isFuzzy, nil
}
@ -167,25 +168,28 @@ func handleLevelFuzzySearch(ctx context.Context, rdb *redis.Client, level int, k
}
if keyExists {
if hierarchy == constants.MaxIdentifyHierarchy {
return []string{""}, false, nil
}
return []string{"."}, false, nil
}
// start redis fuzzy search
recommends, err := runFuzzySearch(ctx, searchInput, level)
recommends, err := runFuzzySearch(ctx, searchInput, searchPrefix, hierarchy)
if err != nil {
logger.Error(ctx, "fuzzy search failed for level", "level", level, "search_input", searchInput, "error", err)
logger.Error(ctx, "fuzzy search failed by hierarchy", "hierarchy", hierarchy, "search_input", searchInput, "error", err)
return []string{}, false, err
}
if len(recommends) == 0 {
logger.Error(ctx, "fuzzy search without result", "level", level, "search_input", searchInput, "error", err)
logger.Error(ctx, "fuzzy search without result", "hierarchy", hierarchy, "search_input", searchInput, "error", err)
return []string{}, true, nil
}
return combineQueryResultByInput(level, inputSlice, recommends), true, nil
return combineQueryResultByInput(hierarchy, inputSlice, recommends), true, nil
}
// runFuzzySearch define func to process redis fuzzy search
func runFuzzySearch(ctx context.Context, searchInput string, inputSliceLen int) ([]string, error) {
func runFuzzySearch(ctx context.Context, searchInput string, searchPrefix string, inputSliceLen int) ([]string, error) {
searchInputLen := len(searchInput)
for searchInputLen != 0 {
@ -210,8 +214,24 @@ func runFuzzySearch(ctx context.Context, searchInput string, inputSliceLen int)
var recommends []string
for _, result := range results {
termSlice := strings.Split(result.Term, ".")
if len(termSlice) <= inputSliceLen {
term := result.Term
var termSliceLen int
var termPrefix string
lastDotIndex := strings.LastIndex(term, ".")
if lastDotIndex == -1 {
termPrefix = ""
} else {
termPrefix = term[:lastDotIndex]
}
if result.Term == "" {
termSliceLen = 1
} else {
termSliceLen = strings.Count(result.Term, ".") + 1
}
if termSliceLen == inputSliceLen && termPrefix == searchPrefix {
recommends = append(recommends, result.Term)
}
}

View File

@ -23,7 +23,7 @@ type TopologicUUIDCreateInfo struct {
Comment string `json:"comment"`
}
// ComponentCreateInfo defines circuit diagram component create index info
// ComponentCreateInfo defines circuit diagram component create info
type ComponentCreateInfo struct {
UUID string `json:"uuid"`
Name string `json:"name"`
@ -37,6 +37,20 @@ type ComponentCreateInfo struct {
Op int `json:"op"`
}
// MeasurementCreateInfo defines circuit diagram measurement create info
type MeasurementCreateInfo struct {
UUID string `json:"uuid"`
Name string `json:"name"`
Context map[string]any `json:"context"`
GridID int64 `json:"grid_id"`
ZoneID int64 `json:"zone_id"`
StationID int64 `json:"station_id"`
PageID int64 `json:"page_id"`
Tag string `json:"tag"`
Params string `json:"params"`
Op int `json:"op"`
}
// CircuitDiagramCreateRequest defines request params of circuit diagram create api
type CircuitDiagramCreateRequest struct {
PageID int64 `json:"page_id"`

View File

@ -7,6 +7,15 @@ type MeasurementGetRequest struct {
MeasurementToken string `json:"token" example:"some-token"`
}
// MeasurementLinkRequest defines the request payload for process an measurement link
type MeasurementLinkRequest struct {
// required: true
MeasurementID int64 `json:"measurement_id" example:"1001"`
// required: true
// enum: [add, del]
Action string `json:"action" example:"add"`
}
// MeasurementRecommendRequest defines the request payload for an measurement recommend
type MeasurementRecommendRequest struct {
Input string `form:"input,omitempty" example:"grid1"`