feat: refactor type to use enum

Author: sixwaaaay

graal/src/main/java/io/sixwaaaay/sharingcomment/controller/CommentController.java

@@ -30,8 +30,6 @@
 import java.time.ZoneOffset;
 import java.util.Optional;
 
-import static io.sixwaaaay.sharingcomment.util.ShardEnum.transformId;
-
 @RestController
 @RequestMapping("/comments")
 @AllArgsConstructor
@@ -48,13 +46,13 @@ public class CommentController {
      */
     @GetMapping("/main")
     public CommentResult getMainCommentList(
-            @RequestParam("type") String type,
+            @RequestParam("type") ShardEnum.Shard type,
             @RequestParam("belong_to") Long belongTo,
             @RequestParam(value = "page") Optional<Long> id,
             @RequestParam(value = "size", defaultValue = "10") Integer size
     ) {
         var userId = Principal.currentUserId();
-        belongTo = transformId(belongTo, ShardEnum.getShard(type));
+        belongTo = type.transform(belongTo);
         return commentService.getMainCommentList(belongTo, id.orElse(Long.MAX_VALUE), size, userId);
     }
 
@@ -66,14 +64,14 @@ public CommentResult getMainCommentList(
      */
     @GetMapping("/reply")
     public ReplyResult getReplyCommentList(
-            @RequestParam("type") String type,
+            @RequestParam("type") ShardEnum.Shard type,
             @RequestParam("belong_to") Long belongTo,
             @RequestParam("reply_to") Long replyTo,
             @RequestParam(value = "page", defaultValue = "0") long id,
             @RequestParam(value = "size", defaultValue = "10") Integer size
     ) {
         var userId = Principal.currentUserId();
-        belongTo = transformId(belongTo, ShardEnum.getShard(type));
+        belongTo = type.transform(belongTo);
         return commentService.getReplyCommentList(belongTo, replyTo, id, size, userId);
     }
 
@@ -83,11 +81,14 @@ public ReplyResult getReplyCommentList(
      * @return the created comment
      */
     @PostMapping
-    public Comment createComment(@Valid @RequestBody CommentRequest request) {
+    public Comment createComment(
+            @Valid @RequestBody CommentRequest request
+    ) {
         var comment = new Comment();
         var id = Principal.currentUserId();
         comment.setUserId(id);
-        comment.setBelongTo(transformId(request.getBelongTo(), ShardEnum.getShard(request.getType())));
+        var belongTo = request.getType().transform(request.getBelongTo());
+        comment.setBelongTo(belongTo);
         comment.setContent(request.getContent());
         comment.setReferTo(request.getReferTo());
         comment.setReplyTo(request.getReplyTo());

graal/src/main/java/io/sixwaaaay/sharingcomment/request/CommentRequest.java

@@ -14,6 +14,7 @@
 package io.sixwaaaay.sharingcomment.request;
 
 import com.fasterxml.jackson.annotation.JsonProperty;
+import io.sixwaaaay.sharingcomment.util.ShardEnum;
 import jakarta.validation.Valid;
 import jakarta.validation.constraints.AssertTrue;
 import jakarta.validation.constraints.NotNull;
@@ -34,7 +35,7 @@ public class CommentRequest {
      */
     @NotNull
     @JsonProperty("type")
-    private String type;
+    private ShardEnum.Shard type;
 
     /**
      * The content of the comment.
@@ -73,9 +74,4 @@ public class CommentRequest {
     public boolean isValid() {
         return (replyTo == null && referTo == null) || (replyTo != null && referTo != null);
     }
-
-    @AssertTrue(message = "type must be one of 'chore', 'default', 'video', 'post', 'music'")
-    public boolean isValidType() {
-        return type.equals("chore") || type.equals("default") || type.equals("video") || type.equals("post") || type.equals("music");
-    }
 }

graal/src/main/java/io/sixwaaaay/sharingcomment/util/ShardEnum.java

@@ -13,52 +13,46 @@
 
 package io.sixwaaaay.sharingcomment.util;
 
-import lombok.Getter;
+import com.fasterxml.jackson.annotation.JsonProperty;
 
 public class ShardEnum {
-    // 最高位不使用， 次高位(62位) 到第60位(1位) 用于存储分片ID
-    // 共3位，八个分片
+    /*
+    the highest bit is not used,
+    the second-highest bit (62) to the 60th bit is used to store the shard ID.
+    in total, 3 bits, so there are at most 8 shards.
+    */
     public static final long Chore = 0L; // aka 0b000L << 60;
     public static final long SHARD_ID_0 = 0b001L << 60;
     public static final long SHARD_ID_1 = 0b010L << 60;
     public static final long SHARD_ID_2 = 0b011L << 60;
     public static final long SHARD_ID_3 = 0b100L << 60;
 
-    public static Shard getShard(String shard) {
-        return switch (shard) {
-            case "chore" -> Shard.ChoreShard;
-            case "default" -> Shard.SHARD_0;
-            case "video" -> Shard.Video;
-            case "post" -> Shard.post;
-            case "music" -> Shard.music;
-            default -> throw new IllegalArgumentException("Unknown shard: " + shard);
-        };
-    }
-
-
-    @Getter
     public enum Shard {
-        ChoreShard(Chore),
-        SHARD_0(SHARD_ID_0),
-        Video(SHARD_ID_1),
+        @JsonProperty("chore")
+        chore(Chore),
+        @JsonProperty("default")
+        SHARD(SHARD_ID_0),
+        @JsonProperty("video")
+        video(SHARD_ID_1),
+        @JsonProperty("post")
         post(SHARD_ID_2),
+        @JsonProperty("music")
         music(SHARD_ID_3);
 
         private final long shardId;
 
         Shard(long shardId) {
             this.shardId = shardId;
         }
-    }
 
-    /**
-     * transform id to shard id
-     *
-     * @param id   id
-     * @param shard shard
-     * @return the id embed shard id
-     */
-    public static long transformId(long id, Shard shard) {
-        return shard.getShardId() | id;
+        /**
+         * transform id to shard id
+         *
+         * @param id id
+         * @return the id embed shard id
+         */
+        public long transform(long id) {
+            return this.shardId | id;
+        }
     }
 }