feat: 支持私有仓库快照版本 Javadoc 浏览

Author: weibiansanjue

antora-playbook.yml

@@ -13,7 +13,7 @@ content:
   sources:
   # 本项目文档
   - url: https://github.com/DocsAggregationTools/javadochub.git
-    branches: develop
+    branches: main
     start_path: docs
 
 

docs/modules/ROOT/pages/changelog.adoc

@@ -1,3 +1,5 @@
 = Changelog
 
-== xx
+== v0.3.0-20240810
+
+* 支持私有仓库快照版本 Javadoc 浏览

src/main/java/world/weibiansanjue/doctools/javadochub/controller/JavadocController.java

@@ -3,15 +3,16 @@
 import lombok.extern.slf4j.Slf4j;
 import org.apache.commons.lang3.StringUtils;
 import org.apache.maven.artifact.repository.metadata.Versioning;
-import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Qualifier;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.stereotype.Controller;
 import org.springframework.util.AntPathMatcher;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.servlet.ModelAndView;
-import world.weibiansanjue.doctools.javadochub.repository.Repository;
+import world.weibiansanjue.doctools.javadochub.repository.IRepository;
 
+import javax.annotation.Resource;
 import javax.servlet.http.HttpServletRequest;
 import java.io.IOException;
 
@@ -25,18 +26,25 @@
 @Controller
 public class JavadocController {
 
-    private static final String URL_GA   = "/doc/{groupId}/{artifactId}";
-    private static final String URL_PAGE = "/doc/{groupId}/{artifactId}/{version}/**";
+    private static final String URL_GA   = "/{rep:doc|snapshot}/{groupId}/{artifactId}";
+    private static final String URL_PAGE = "/{rep:doc|snapshot}/{groupId}/{artifactId}/{version}/**";
 
     private static final String INDEX_PAGE = "overview-summary.html";
 
     @Value("${javadochub.version}")
     private String JAVADOCHUB_VERSION;
 
-    @Autowired
-    private Repository repository;
+    @Resource
+    @Qualifier("repository")
+    private IRepository repositoryRelease;
 
-    @GetMapping(value = "/doc")
+    @Resource
+    private IRepository repositorySnapshot;
+
+    private IRepository repository;
+
+
+    @GetMapping(value = "/{rep:doc|snapshot}")
     public String redirectHelp() {
         return "redirect:/";
     }
@@ -54,11 +62,11 @@ public String redirectHelp() {
      */
     @GetMapping(value = URL_GA)
     public ModelAndView getJavadocUrl(ModelAndView modelView,
+                                      @PathVariable("rep")        String rep,
                                       @PathVariable("groupId")    String groupId,
                                       @PathVariable("artifactId") String artifactId) throws IOException {
-
-        extract(modelView, groupId, artifactId, null, INDEX_PAGE);
-
+        repository = getRepository(groupId, rep);
+        extract(modelView, groupId, artifactId, null, INDEX_PAGE, resetRep(groupId, rep));
         return modelView;
     }
 
@@ -77,29 +85,47 @@ public ModelAndView getJavadocUrl(ModelAndView modelView,
      */
     @GetMapping(value = URL_PAGE)
     public ModelAndView getJavadocUrl(ModelAndView modelView,
+                                      @PathVariable("rep")        String rep,
                                       @PathVariable("groupId")    String groupId,
                                       @PathVariable("artifactId") String artifactId,
                                       @PathVariable("version")    String version,
                                       HttpServletRequest          request) throws IOException {
 
+
+        repository = getRepository(groupId, rep);
         String page = new AntPathMatcher().extractPathWithinPattern(URL_PAGE, request.getServletPath());
         page = StringUtils.isEmpty(page) ? INDEX_PAGE : page;
-        extract(modelView, groupId, artifactId, version, page);
+        extract(modelView, groupId, artifactId, version, page, resetRep(groupId, rep));
 
         return modelView;
     }
 
+    private IRepository getRepository(String groupId, String rep) {
+        if ("snapshot".equals(rep) && repositorySnapshot.isInternal(groupId)) {
+            return repositorySnapshot;
+        }
+        return repositoryRelease;
+    }
+
+    private String resetRep(String groupId, String rep) {
+        if ("snapshot".equals(rep) && repositorySnapshot.isInternal(groupId)){
+            return rep;
+        }
+        return "doc";
+    }
+
     private void extract(ModelAndView modelView,
-        String groupId, String artifactId, String version, String page) throws IOException {
+        String groupId, String artifactId, String version, String page, String rep) throws IOException {
 
-        log.info("extract javadoc. g={} a={} v={} p={}", groupId, artifactId, version, page);
+        log.info("extract javadoc. g={} a={} v={} p={} rep={}", groupId, artifactId, version, page, rep);
 
         modelView.addObject("appversion", "v" + JAVADOCHUB_VERSION)
             .addObject("groupId", groupId)
             .addObject("artifactId", artifactId)
             .addObject("artifactIds", repository.artifact(groupId))
             .addObject("page", page)
-            .setViewName("doc");
+            .addObject("isInternal", repository.isInternal(groupId))
+            .setViewName(rep);
 
         Versioning versioning = repository.version(groupId, artifactId);
         if (null == versioning) {

src/main/java/world/weibiansanjue/doctools/javadochub/repository/IRepository.java

@@ -0,0 +1,109 @@
+package world.weibiansanjue.doctools.javadochub.repository;
+
+import org.apache.maven.artifact.repository.metadata.Versioning;
+
+import java.io.IOException;
+import java.util.List;
+
+/**
+ * 仓库操作.
+ *
+ * @author weibiansanjue
+ * @since 0.3.0
+ */
+public interface IRepository {
+
+
+    /**
+     * 获取本地 artifact 名词集合.
+     *
+     * @author weibiansanjue
+     * @param groupId group id
+     * @return artifact name list
+     * @since 0.1.0
+     */
+    List<String> artifact(String groupId);
+
+    /**
+     * 获取 maven 仓库中 javadoc 版本.
+     *
+     * @author weibiansanjue
+     * @param groupId group id
+     * @param artifactId artifact id
+     * @return remote metadata
+     * @since 0.1.0
+     */
+    Versioning version(String groupId, String artifactId);
+
+    /**
+     * 获取 maven 仓库中 javadoc 快照版本.
+     *
+     * @author weibiansanjue
+     * @param groupId group id
+     * @param artifactId artifact id
+     * @param version version
+     * @return remote metadata
+     * @since 0.3.0
+     */
+    Versioning version(String groupId, String artifactId, String version);
+
+    /**
+     * metadata url.
+     *
+     * @author weibiansanjue
+     * @param groupId group id
+     * @param artifactId artifact id
+     * @return remote metadata url
+     * @since 0.2.0
+     */
+    String metadataUrl(String groupId, String artifactId);
+
+    /**
+     * 删除 javadoc page
+     *
+     * @author weibiansanjue
+     * @param groupId group id
+     * @param artifactId artifact id
+     * @param version version
+     * @return 删除成功
+     * @throws IOException io e
+     * @since 0.2.0
+     */
+    boolean delete(String groupId, String artifactId, String version) throws IOException;
+
+    /**
+     * 下载、解压 javadoc.jar.
+     *
+     * @author weibiansanjue
+     * @param groupId group id
+     * @param artifactId artifact id
+     * @param version version
+     * @return status
+     * @throws IOException io exception
+     * @since 0.1.0
+     */
+    int store(String groupId, String artifactId, String version) throws IOException;
+
+    /**
+     * javadoc jar download url.
+     *
+     * @author weibiansanjue
+     * @param groupId group id
+     * @param artifactId artifact id
+     * @param version version
+     * @return url
+     * @since 0.2.0
+     */
+    String javadocDownloadUrl(String groupId, String artifactId, String version);
+
+    /**
+     * is internal package
+     *
+     * @author weibiansanjue
+     * @param groupId group Id
+     * @return is internal package
+     * @since 0.3.0
+     */
+    Boolean isInternal(String groupId);
+
+}

src/main/java/world/weibiansanjue/doctools/javadochub/repository/Repository.java

@@ -36,7 +36,7 @@
  */
 @Slf4j
 @Component("repository")
-public class Repository implements CommandLineRunner {
+public class Repository implements IRepository, CommandLineRunner {
 
     @Value("${javadochub.storage}/storage")
     private String LOCAL_PATH;
@@ -110,6 +110,11 @@ public Versioning version(String groupId, String artifactId) {
         return versioning;
     }
 
+    @Override
+    public Versioning version(String groupId, String artifactId, String version) {
+        return null;
+    }
+
     /**
      * metadata url.
      *
@@ -214,6 +219,16 @@ public String javadocDownloadUrl(String groupId, String artifactId, String versi
                              javadocJarName(artifactId, version));
     }
 
+    @Override
+    public Boolean isInternal(String groupId) {
+        for (String prefix : INTERNAL_GROUP_PREFIX) {
+            if (groupId.startsWith(prefix)) {
+                return true;
+            }
+        }
+        return false;
+    }
+
     private String javadocJarName(String artifactId, String version) {
         return artifactId + "-" + version + "-javadoc.jar";
     }