feat: 用户操作日志

Author: hahaAO

ServiceV2/client_log.go

@@ -0,0 +1,50 @@
+package ServiceV2
+
+import (
+	"code/Hahachitchat/dataLayer"
+	"code/Hahachitchat/definition"
+	"github.com/gin-gonic/gin"
+	"github.com/gorilla/websocket"
+	"net/http"
+)
+
+func InitClientLog() {
+	definition.ClientLogChan = make(chan string, 500)
+	definition.WsLogConnChan = make(chan struct{}, 1)
+}
+
+func LogWebSocketConnect(c *gin.Context) {
+	select {
+	case definition.WsLogConnChan <- struct{}{}:
+	default: // 只允许一个连接
+		c.JSON(http.StatusOK, definition.CommonResponse{
+			State:        definition.ServerError,
+			StateMessage: "服务器繁忙",
+		})
+		return
+	}
+	defer func() {
+		<-definition.WsLogConnChan // 释放连接
+	}()
+
+	upGrader := websocket.Upgrader{
+		CheckOrigin: func(r *http.Request) bool {
+			return true
+		},
+	}
+	ws, err := upGrader.Upgrade(c.Writer, c.Request, nil)
+	defer ws.Close()
+	if err != nil {
+		dataLayer.Serverlog.Println("[WebSocketConnect] err: ", err)
+		return
+	}
+
+	for {
+		log := <-definition.ClientLogChan
+		err := ws.WriteMessage(websocket.TextMessage, []byte(log))
+		if err != nil {
+			dataLayer.Serverlog.Println("[LogWebSocketConnect] err: ", err)
+			break
+		}
+	}
+}

ServiceV2/middleWare.go

@@ -1,9 +1,11 @@
 package ServiceV2
 
 import (
+	"bytes"
 	"code/Hahachitchat/dataLayer"
 	"code/Hahachitchat/definition"
 	"code/Hahachitchat/utils"
+	"encoding/json"
 	"github.com/gin-gonic/gin"
 	"net/http"
 )
@@ -98,3 +100,43 @@ func SetSessionMiddleWare() gin.HandlerFunc { // 用户有登录态则写入，
 		c.Next()
 	}
 }
+
+func ClientLogMiddleWare() gin.HandlerFunc {
+	return func(c *gin.Context) {
+		blw := &definition.CustomResponseWriter{Body: bytes.NewBufferString(""), ResponseWriter: c.Writer}
+		c.Writer = blw
+		c.Next()
+		if operateName, exist := definition.URLMapOperateName[c.Request.URL.Path]; exist {
+			var responseMessage definition.CommonResponse
+			json.Unmarshal([]byte(blw.Body.String()), &responseMessage)
+			clientLog := definition.ClientLog{
+				IP:             c.ClientIP(),
+				Uid:            nil,
+				OperateName:    operateName,
+				HttpStatusCode: c.Writer.Status(),
+				ResponseMessage: definition.ResponseMessage{
+					State:        responseMessage.State,
+					StateMessage: responseMessage.StateMessage,
+				},
+			}
+
+			userId, exists := c.Get("u_id")
+			uid, ok := userId.(uint64)
+			if exists && ok {
+				clientLog.Uid = &uid // 有登录态
+			}
+			b, _ := json.Marshal(&clientLog)
+			select {
+			case definition.ClientLogChan <- string(b):
+			default: // 阻塞时先消费 50 个再写入
+				for i := 0; i < 50; i++ {
+					select {
+						case <-definition.ClientLogChan:
+						default: // 防止消费阻塞
+					}
+				}
+				definition.ClientLogChan <- string(b)
+			}
+		}
+	}
+}

ServiceV2/newService.go

@@ -3,9 +3,7 @@ package ServiceV2
 import (
 	"code/Hahachitchat/dataLayer"
 	"code/Hahachitchat/definition"
-	"github.com/chenjiandongx/ginprom"
 	"github.com/gin-gonic/gin"
-	"github.com/prometheus/client_golang/prometheus/promhttp"
 	"os"
 )
 
@@ -36,40 +34,36 @@ func StartService(port string) {
 	ServiceInit()
 
 	r := gin.Default()
-	// use prometheus metrics exporter middleware.
-	r.Use(ginprom.PromMiddleware(ginprom.NewDefaultOpts()))
 
-	// register the `/metrices` route.
+	r.Use(HearsetMiddleWare())
 
-	r.GET("/metrics", ginprom.PromHandler(promhttp.Handler()))
+	clientRoute := r.Group("", ClientLogMiddleWare(), ForbiddenMiddleWare())
 
-	r.Use(HearsetMiddleWare(), ForbiddenMiddleWare())
+	clientRoute.GET("/", DefaultTest)
+	clientRoute.GET("/allpostid", AllPostId)
+	clientRoute.GET("/top-post", GetTopPost)
+	clientRoute.GET("/allcommentid/:post_id", AllCommentIdByPostId)
+	clientRoute.GET("/user/:u_id", GetUserById)
+	clientRoute.GET("/post/:post_id", GetPostById)
+	clientRoute.GET("/comment/:comment_id", GetCommentById)
+	clientRoute.GET("/reply/:reply_id", GetReplyById)
+	clientRoute.GET("/allposthot", AllPostHot)
+	clientRoute.GET("/getimg/:img_id", GetImg)
+	clientRoute.GET("/id-by-name/:u_nickname", GetUidByUserNickname)
 
-	r.GET("/", DefaultTest)
-	r.GET("/allpostid", AllPostId)
-	r.GET("/top-post", GetTopPost)
-	r.GET("/allcommentid/:post_id", AllCommentIdByPostId)
-	r.GET("/user/:u_id", GetUserById)
-	r.GET("/post/:post_id", GetPostById)
-	r.GET("/comment/:comment_id", GetCommentById)
-	r.GET("/reply/:reply_id", GetReplyById)
-	r.GET("/allposthot", AllPostHot)
-	r.GET("/getimg/:img_id", GetImg)
-	r.GET("/id-by-name/:u_nickname", GetUidByUserNickname)
-
-	r.POST("/register", Register)
-	r.POST("/login", Login)
+	clientRoute.POST("/register", Register)
+	clientRoute.POST("/login", Login)
 
 	//可能需要登录态的操作 个人资料(根据用户隐私设置判断是否展示)
-	profileRoute := r.Group("/profile", SetSessionMiddleWare())
+	profileRoute := clientRoute.Group("/profile", SetSessionMiddleWare())
 	profileRoute.GET("/user-saved/:u_id", GetUserSavedPost)
 	profileRoute.GET("/subscriptions/:u_id", GetSubscriptions)
 	profileRoute.GET("/allpostid-by-uid/:u_id", GetUserAllPostId)
 	profileRoute.GET("/allcommentid-by-uid/:u_id", GetUserAllCommentId)
 	profileRoute.GET("/allreplyid-by-uid/:u_id", GetUserAllReplyId)
 
 	// 需要登录态的操作
-	needSessionRoute := r.Group("", AuthMiddleWare())
+	needSessionRoute := clientRoute.Group("", AuthMiddleWare())
 
 	needSessionRoute.GET("/user_state", GetUserState)
 	needSessionRoute.GET("/ws-connect", WebSocketConnect)
@@ -100,13 +94,13 @@ func StartService(port string) {
 	MessageRoute.POST("/ignore", IgnoreMessages)
 
 	// ------------V2--------------
-	routeV2 := r.Group("/v2")
+	routeV2 := clientRoute.Group("/v2")
 	routeV2.GET("/zone/:zone", AllPostByZone)
 	routeV2.GET("/comment/:comment_id", GetCommentByIdV2)
 	routeV2.POST("/posts", BatchQueryPost)
 
 	// 点赞功能
-	voteRoute := r.Group("/vote")
+	voteRoute := clientRoute.Group("/vote")
 	voteRoute.GET("/post/:post_id", GetPostVote)
 	voteRoute.GET("/comment/:comment_id", GetCommentVote)
 	voteRoute.POST("/post", AuthMiddleWare(), VotePost)
@@ -117,7 +111,7 @@ func StartService(port string) {
 	adminRoute.GET("/users", GetAllUser)
 	adminRoute.GET("/ban-users", GetBanUser)
 	adminRoute.POST("/add-ban-users", AddBanUser)
-	adminRoute.POST("/cancel-ban-users",CancelBanUser)
+	adminRoute.POST("/cancel-ban-users", CancelBanUser)
 	adminRoute.GET("/ban-ips", GetBanIPs)
 	adminRoute.POST("/add-ban-ips", AddBanIP)
 	adminRoute.POST("/cancel-ban-ip", CancelBanIp)
@@ -127,11 +121,11 @@ func StartService(port string) {
 	adminRoute.POST("/delete-reply", AdminDeleteReplyById)
 	adminRoute.POST("/set-top-post", SetTopPost)
 	// 审批功能
-	adminRoute.POST("/set-approval-user",SetApprovalUser)
-	adminRoute.GET("/need-approval-post",GetNeedApprovalPost)
-	adminRoute.POST("/approval-post",ApprovalPost)
+	adminRoute.POST("/set-approval-user", SetApprovalUser)
+	adminRoute.GET("/need-approval-post", GetNeedApprovalPost)
+	adminRoute.POST("/approval-post", ApprovalPost)
 	//日志功能
-
+	adminRoute.GET("/log-ws-connect", LogWebSocketConnect)
 	// 查看统计图
 	postStatisticsRoute := adminRoute.Group("/post-statistics")
 	postStatisticsRoute.GET("/line-chart", PostStatisticsLineChart)

definition/client_log.go

@@ -0,0 +1,49 @@
+package definition
+
+import (
+	"bytes"
+	"github.com/gin-gonic/gin"
+)
+
+var ClientLogChan chan string
+var WsLogConnChan chan struct{}
+
+type CustomResponseWriter struct {
+	gin.ResponseWriter
+	Body *bytes.Buffer
+}
+
+func (w CustomResponseWriter) Write(b []byte) (int, error) {
+	w.Body.Write(b)
+	return w.ResponseWriter.Write(b)
+}
+
+func (w CustomResponseWriter) WriteString(s string) (int, error) {
+	w.Body.WriteString(s)
+	return w.ResponseWriter.WriteString(s)
+}
+
+type ResponseMessage struct {
+	State        int    `json:"业务状态码"`
+	StateMessage string `json:"响应消息"`
+}
+
+type ClientLog struct {
+	IP              string          `json:"IP地址"`
+	Uid             *uint64         `json:"用户ID(可空)"`
+	OperateName     string          `json:"用户操作"`
+	HttpStatusCode  int             `json:"HTTP响应"`
+	ResponseMessage ResponseMessage `json:"操作结果"`
+}
+
+var URLMapOperateName = map[string]string{
+	"/register": "用户注册",
+	"/login": "用户登录",
+	"/create-post": "用户发贴",
+	"/create-comment": "发表评论",
+	"/create-reply": "发表回复",
+	"/delete-post": "删除贴子",
+	"/delete-comment": "删除评论",
+	"/delete-reply": "删除回复",
+	"/uploadimg": "更换头像",
+}