springboot访问静态资源--javadoc文档集成到springboot的maven项目中

最新推荐文章于 2025-05-16 16:25:31 发布

noob_boss

最新推荐文章于 2025-05-16 16:25:31 发布

阅读量939

点赞数 1

CC 4.0 BY-SA版权

分类专栏：应用框架文章标签： java spring boot maven spring

本文链接：https://blog.youkuaiyun.com/noob_boss/article/details/106353726

应用同时被 2 个专栏收录

6 篇文章

订阅专栏

框架

3 篇文章

订阅专栏

本文介绍如何在Maven项目中使用maven-javadoc-plugin生成Javadoc文档，并详细解释了配置项的作用。同时，文章还提供了SpringBoot项目的application.yml配置示例，用于正确映射生成的Javadoc文档，使文档可通过特定URL访问。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

一、maven项目生成javadoc文档
引入依赖

<plugin>
		<groupId>org.apache.maven.plugins</groupId>
		<artifactId>maven-javadoc-plugin</artifactId>
		<version>3.0.1</version>
		<configuration>
			<doclint>none</doclint> <!--忽略调无法识别注释的创建错误-->
			<excludePackageNames>
				com.xxx.xxx:com.xxx.xxx
			</excludePackageNames>
			<reportOutputDirectory>src/main/resources/static</reportOutputDirectory>
		</configuration>
</plugin>

标签解释：
<excludePackageNames></excludePackageNames>去除不需要生成javadoc的目录或类
<reportOutputDirectory></reportOutputDirectory>生成的javadoc存放目录

生成javadoc的maven命令：mvn javadoc:javadoc

二、springboot配置文件
applycation.yml配置文件修改，在spring节点下加入如下配置：

mvc:
    static-path-pattern: /dataapidoc/**
  resources:
    static-locations: classpath:/static/apidocs/

配置解释：
static-path-pattern: /dataapidoc/** 设置静态资源访问的虚拟目录，如果不加此配置，在访问静态资源的时候，springboot默认会解析到Java类上，后面一定要配置两个*，这样会递归访问所有的静态资源包括js和css等。
static-locations: classpath:/static/apidocs/ springboot默认约定静态资源放在static下

总结：以上配置完成之后，启动maven项目，就可访问生成的Javadoc文件，访问url：http://localhost:8080/dataapidoc/index.html