feat: cache in academic scores

cmd/academic/main.go

@@ -27,18 +27,23 @@ import (
 	"github.com/west2-online/fzuhelper-server/config"
 	"github.com/west2-online/fzuhelper-server/internal/academic"
 	"github.com/west2-online/fzuhelper-server/kitex_gen/academic/academicservice"
+	"github.com/west2-online/fzuhelper-server/pkg/base"
 	"github.com/west2-online/fzuhelper-server/pkg/constants"
 	"github.com/west2-online/fzuhelper-server/pkg/logger"
 	"github.com/west2-online/fzuhelper-server/pkg/utils"
 )
 
-var serviceName = constants.AcademicServiceName
+var (
+	serviceName = constants.AcademicServiceName
+	clientSet   *base.ClientSet
+)
 
 func init() {
 	config.Init(serviceName)
 	logger.Init(serviceName, config.GetLoggerLevel())
 	// eshook.InitLoggerWithHook(serviceName)
-	// dal.Init() // TODO 增加成绩信息持久化开始推送
+	clientSet = base.NewClientSet(base.WithRedisClient(constants.RedisDBAcademic))
+	// TODO 增加成绩信息持久化开始推送
 }
 
 func main() {
@@ -56,7 +61,7 @@ func main() {
 	}
 
 	svr := academicservice.NewServer(
-		new(academic.AcademicServiceImpl),
+		academic.NewAcademicService(clientSet),
 		server.WithServerBasicInfo(&rpcinfo.EndpointBasicInfo{
 			ServiceName: serviceName,
 		}),

internal/academic/handler.go

@@ -28,15 +28,22 @@ import (
 )
 
 // AcademicServiceImpl implements the last service interface defined in the IDL.
-type AcademicServiceImpl struct{}
+type AcademicServiceImpl struct {
+	ClientSet *base.ClientSet
+}
+
+func NewAcademicService(clientSet *base.ClientSet) *AcademicServiceImpl {
+	return &AcademicServiceImpl{
+		ClientSet: clientSet,
+	}
+}
 
 // GetScores implements the AcademicServiceImpl interface.
-func (s *AcademicServiceImpl) GetScores(ctx context.Context, req *academic.GetScoresRequest) (resp *academic.GetScoresResponse, err error) {
+func (s *AcademicServiceImpl) GetScores(ctx context.Context, _ *academic.GetScoresRequest) (resp *academic.GetScoresResponse, err error) {
 	resp = academic.NewGetScoresResponse()
 	var scores []*jwch.Mark
-	l := service.NewAcademicService(ctx)
 
-	scores, err = l.GetScores()
+	scores, err = service.NewAcademicService(ctx, s.ClientSet).GetScores()
 	if err != nil {
 		logger.Infof("Academic.GetScores: GetScores failed, err: %v", err)
 		resp.Base = base.BuildBaseResp(err)
@@ -49,12 +56,11 @@ func (s *AcademicServiceImpl) GetScores(ctx context.Context, req *academic.GetSc
 }
 
 // GetGPA implements the AcademicServiceImpl interface.
-func (s *AcademicServiceImpl) GetGPA(ctx context.Context, req *academic.GetGPARequest) (resp *academic.GetGPAResponse, err error) {
+func (s *AcademicServiceImpl) GetGPA(ctx context.Context, _ *academic.GetGPARequest) (resp *academic.GetGPAResponse, err error) {
 	resp = academic.NewGetGPAResponse()
 	var gpa *jwch.GPABean
-	l := service.NewAcademicService(ctx)
 
-	gpa, err = l.GetGPA()
+	gpa, err = service.NewAcademicService(ctx, s.ClientSet).GetGPA()
 	if err != nil {
 		logger.Infof("Academic.GetGPA: GetGPA failed, err: %v", err)
 		resp.Base = base.BuildBaseResp(err)
@@ -66,12 +72,11 @@ func (s *AcademicServiceImpl) GetGPA(ctx context.Context, req *academic.GetGPARe
 }
 
 // GetCredit implements the AcademicServiceImpl interface.
-func (s *AcademicServiceImpl) GetCredit(ctx context.Context, req *academic.GetCreditRequest) (resp *academic.GetCreditResponse, err error) {
+func (s *AcademicServiceImpl) GetCredit(ctx context.Context, _ *academic.GetCreditRequest) (resp *academic.GetCreditResponse, err error) {
 	resp = academic.NewGetCreditResponse()
 	var credit []*jwch.CreditStatistics
-	l := service.NewAcademicService(ctx)
 
-	credit, err = l.GetCredit()
+	credit, err = service.NewAcademicService(ctx, s.ClientSet).GetCredit()
 	if err != nil {
 		logger.Infof("Academic.GetCredit: GetCredit failed, err: %v", err)
 		resp.Base = base.BuildBaseResp(err)
@@ -84,12 +89,11 @@ func (s *AcademicServiceImpl) GetCredit(ctx context.Context, req *academic.GetCr
 }
 
 // GetUnifiedExam implements the AcademicServiceImpl interface.
-func (s *AcademicServiceImpl) GetUnifiedExam(ctx context.Context, req *academic.GetUnifiedExamRequest) (resp *academic.GetUnifiedExamResponse, err error) {
+func (s *AcademicServiceImpl) GetUnifiedExam(ctx context.Context, _ *academic.GetUnifiedExamRequest) (resp *academic.GetUnifiedExamResponse, err error) {
 	resp = academic.NewGetUnifiedExamResponse()
 	var unifiedExam []*jwch.UnifiedExam
-	l := service.NewAcademicService(ctx)
 
-	unifiedExam, err = l.GetUnifiedExam()
+	unifiedExam, err = service.NewAcademicService(ctx, s.ClientSet).GetUnifiedExam()
 	if err != nil {
 		logger.Infof("Academic.GetUnifiedExam: GetUnifiedExam failed, err: %v", err)
 		resp.Base = base.BuildBaseResp(err)
@@ -102,9 +106,9 @@ func (s *AcademicServiceImpl) GetUnifiedExam(ctx context.Context, req *academic.
 }
 
 // GetPlan implements the AcademicServiceImpl interface.
-func (s *AcademicServiceImpl) GetPlan(ctx context.Context, req *academic.GetPlanRequest) (resp *academic.GetPlanResponse, err error) {
+func (s *AcademicServiceImpl) GetPlan(ctx context.Context, _ *academic.GetPlanRequest) (resp *academic.GetPlanResponse, err error) {
 	resp = new(academic.GetPlanResponse)
-	plan, err := service.NewAcademicService(ctx).GetPlan()
+	plan, err := service.NewAcademicService(ctx, s.ClientSet).GetPlan()
 	if err != nil {
 		resp.Base = base.BuildBaseResp(err)
 		return resp, nil

internal/academic/service/get_credit_test.go

@@ -72,7 +72,7 @@ func TestAcademicService_GetCredit(t *testing.T) {
 					Cookies: "",
 				}, nil
 			}).Build()
-			academicService := NewAcademicService(context.Background())
+			academicService := AcademicService{}
 			result, err := academicService.GetCredit()
 			if tc.expectingError {
 				assert.Nil(t, result)

internal/academic/service/get_gpa_test.go

@@ -78,7 +78,7 @@ func TestAcademicService_GetGPA(t *testing.T) {
 					Cookies: "",
 				}, nil
 			}).Build()
-			academicService := NewAcademicService(context.Background())
+			academicService := AcademicService{}
 			result, err := academicService.GetGPA()
 			if tc.expectingError {
 				assert.Nil(t, result)

internal/academic/service/get_scores.go

@@ -18,7 +18,6 @@ package service
 
 import (
 	"fmt"
-
 	"github.com/west2-online/fzuhelper-server/pkg/base"
 	"github.com/west2-online/fzuhelper-server/pkg/base/context"
 	"github.com/west2-online/fzuhelper-server/pkg/utils"
@@ -30,11 +29,21 @@ func (s *AcademicService) GetScores() ([]*jwch.Mark, error) {
 	if err != nil {
 		return nil, fmt.Errorf("service.GetScores: Get login data fail %w", err)
 	}
-	stu := jwch.NewStudent().WithLoginData(loginData.Id, utils.ParseCookies(loginData.Cookies))
-	scores, err := stu.GetMarks()
-	if err = base.HandleJwchError(err); err != nil {
-		return nil, fmt.Errorf("service.GetScores: Get scores info fail %w", err)
-	}
 
-	return scores, nil
+	key := fmt.Sprintf("scores:%s", loginData.Id)
+	if ok := s.cache.IsKeyExist(s.ctx, key); ok {
+		scores, err := s.cache.Academic.GetScoresCache(s.ctx, key)
+		if err = base.HandleJwchError(err); err != nil {
+			return nil, fmt.Errorf("service.GetScores: Get scores info from redis error %w", err)
+		}
+		return scores, nil
+	} else {
+		stu := jwch.NewStudent().WithLoginData(loginData.Id, utils.ParseCookies(loginData.Cookies))
+		scores, err := stu.GetMarks()
+		if err = base.HandleJwchError(err); err != nil {
+			return nil, fmt.Errorf("service.GetScores: Get scores info fail %w", err)
+		}
+		go s.cache.Academic.SetScoresCache(s.ctx, key, scores)
+		return scores, nil
+	}
 }

internal/academic/service/get_scores_test.go

@@ -80,7 +80,7 @@ func TestAcademicService_GetScores(t *testing.T) {
 						Cookies: "",
 					}, nil
 				}).Build()
-				academicService := NewAcademicService(context.Background())
+				academicService := AcademicService{}
 				result, err := academicService.GetScores()
 				if tc.expectingError {
 					assert.Nil(t, result)

internal/academic/service/get_unified_test.go

@@ -96,7 +96,7 @@ func TestAcademicService_GetUnifiedExam(t *testing.T) {
 						Cookies: "",
 					}, nil
 				}).Build()
-				academicService := NewAcademicService(context.Background())
+				academicService := AcademicService{}
 				result, err := academicService.GetUnifiedExam()
 				if tc.expectingError {
 					assert.Nil(t, result)

internal/academic/service/service.go

@@ -18,14 +18,19 @@ package service
 
 import (
 	"context"
+
+	"github.com/west2-online/fzuhelper-server/pkg/base"
+	"github.com/west2-online/fzuhelper-server/pkg/cache"
 )
 
 type AcademicService struct {
-	ctx context.Context
+	ctx   context.Context
+	cache *cache.Cache
 }
 
-func NewAcademicService(ctx context.Context) *AcademicService {
+func NewAcademicService(ctx context.Context, clientset *base.ClientSet) *AcademicService {
 	return &AcademicService{
-		ctx: ctx,
+		ctx:   ctx,
+		cache: clientset.CacheClient,
 	}
 }

pkg/cache/academic/academic.go

@@ -0,0 +1,29 @@
+/*
+Copyright 2024 The west2-online Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package academic
+
+import "github.com/redis/go-redis/v9"
+
+type CacheAcademic struct {
+	client *redis.Client
+}
+
+func NewCacheAcademic(client *redis.Client) *CacheAcademic {
+	return &CacheAcademic{
+		client: client,
+	}
+}

pkg/cache/academic/get_scores.go

@@ -0,0 +1,38 @@
+/*
+Copyright 2024 The west2-online Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package academic
+
+import (
+	"context"
+
+	"github.com/bytedance/sonic"
+
+	"github.com/west2-online/fzuhelper-server/pkg/errno"
+	"github.com/west2-online/jwch"
+)
+
+func (c *CacheAcademic) GetScoresCache(ctx context.Context, key string) (scores []*jwch.Mark, err error) {
+	data, err := c.client.Get(ctx, key).Bytes()
+	if err != nil {
+		return nil, errno.Errorf(errno.InternalJSONErrorCode, "dal.GetScoresCache: Get scores info failed: %v", err)
+	}
+	err = sonic.Unmarshal(data, &scores)
+	if err != nil {
+		return nil, errno.Errorf(errno.InternalJSONErrorCode, "dal.GetScoresCache: Unmarshal scores info failed: %v", err)
+	}
+	return scores, nil
+}