新增模板相关功能

zyplayer-doc-data/src/main/java/com/zyplayer/doc/data/repository/manage/entity/WikiPageTemplate.java

@@ -8,6 +8,14 @@ import lombok.Data;
 import java.io.Serializable;
 import java.util.Date;
 
+/**
+ * <p>
+ *      ģ<><C4A3><EFBFBD><EFBFBD>Ϣ
+ * </p>
+ *
+ * @author Sh1yu
+ * @since 2023-08-24
+ */
 @Data
 @TableName("wiki_page_template")
 public class WikiPageTemplate implements Serializable {

zyplayer-doc-data/src/main/java/com/zyplayer/doc/data/repository/manage/mapper/WikiPageTemplateMapper.java

@@ -13,18 +13,30 @@ import java.util.List;
 
 /**
  * <p>
- * Mapper 接口
+ *  模板的mapper接口
  * </p>
  *
- * @author 暮光：城中城
- * @since 2019-03-09
+ * @author sh1yu
+ * @since 2023-08-24
  */
 public interface WikiPageTemplateMapper extends BaseMapper<WikiPageTemplate> {
 
+    /**
+     * <p>
+     *      查询所有的模板
+     * </p>
+     */
     List<WikiPageTemplateInfoVo> getAllTemplate(@Param("user") Long user, @Param("name") String name, @Param("share") boolean share, @Param("tags") List tags, @Param("pageNum") Long pageNum);
 
+    /*
+    *  查询所有标签
+    */
     List<WikiTemplateTagVo> getAllTags(@Param("user") Long user,@Param("open") boolean open);
 
+
+    /*
+     *  查询模板总数4分页
+     */
     Long getAllTemplateCount(@Param("user") Long user, @Param("name") String name, @Param("share") boolean share, @Param("tags") List tags);
 
 }

zyplayer-doc-data/src/main/java/com/zyplayer/doc/data/repository/manage/vo/WikiPageTemplateInfoVo.java

@@ -5,7 +5,14 @@ import lombok.Data;
 
 import java.util.Date;
 import java.util.List;
-
+/**
+ * <p>
+ *     模板与文档信息的Vo
+ * </p>
+ *
+ * @author Sh1yu
+ * @since 2023-08-24
+ */
 @Data
 public class WikiPageTemplateInfoVo{
 

zyplayer-doc-data/src/main/java/com/zyplayer/doc/data/repository/manage/vo/WikiTemplateTagVo.java

@@ -4,6 +4,15 @@ import lombok.Data;
 
 import java.util.Date;
 
+
+/**
+ * <p>
+ *     标签信息的Vo
+ * </p>
+ *
+ * @author Sh1yu
+ * @since 2023-08-24
+ */
 @Data
 public class WikiTemplateTagVo {
 

zyplayer-doc-data/src/main/java/com/zyplayer/doc/data/service/manage/WikiPageTemplateService.java

@@ -11,18 +11,32 @@ import java.util.List;
 
 /**
  * <p>
- * 服务类
+ *     模板服务接口
  * </p>
  *
- * @author 暮光：城中城
- * @since 2019-03-09
+ * @author Sh1yu
+ * @since 2023-08-24
  */
 public interface WikiPageTemplateService extends IService<WikiPageTemplate> {
+
+    /**
+     * 根据模板的公开情况获取模板标签
+     */
     public List<WikiTemplateTagVo> getAllTags( Long user, boolean open);
 
+    /**
+     * 根据条件获取模板
+     */
     WikiPageTemplate getWikiPageTemplateBySpaceAndPage(Long spaceId, Long pageId);
 
+
+    /**
+     * 根据条件获取模板信息
+     */
     List<WikiPageTemplateInfoVo> filterAll(Long user, String name, boolean open, List<String> tags, Long pageNum);
 
+    /**
+     * 根据条件获取总条数
+     */
     Long total(Long user, String name, boolean open, List<String> tags);
 }

zyplayer-doc-data/src/main/java/com/zyplayer/doc/data/service/manage/impl/WikiPageTemplateServiceImpl.java

@@ -8,11 +8,17 @@ import com.zyplayer.doc.data.repository.manage.vo.WikiPageTemplateInfoVo;
 import com.zyplayer.doc.data.repository.manage.vo.WikiTemplateTagVo;
 import com.zyplayer.doc.data.service.manage.WikiPageTemplateService;
 import org.apache.commons.lang3.StringUtils;
-import org.apache.ibatis.annotations.Param;
 import org.springframework.stereotype.Service;
 
 import java.util.List;
-
+/**
+ * <p>
+ *     模板服务实现类
+ * </p>
+ *
+ * @author Sh1yu
+ * @since 2023-08-24
+ */
 @Service
 public class WikiPageTemplateServiceImpl extends ServiceImpl<WikiPageTemplateMapper, WikiPageTemplate> implements WikiPageTemplateService {
     @Override

zyplayer-doc-wiki/src/main/java/com/zyplayer/doc/wiki/controller/WikiPageTemplateController.java

@@ -48,11 +48,12 @@ import java.util.*;
 import java.util.stream.Collectors;
 
 /**
- * 文档控制器
+ * <p>
+ *     模板控制器
+ * </p>
  *
- * @author 暮光：城中城
  * @author Sh1yu
- * @since 2019年2月17日
+ * @since 2023-08-24
  */
 @Slf4j
 @AuthMan