1. Información general
Echar un vistazo al código fuente y la documentación de diferentes bibliotecas y marcos es una buena manera de aprender más sobre ellos.
En este breve tutorial, veremos cómo configurar Maven, o pedirle a Maven, que descargue las fuentes de dependencia y sus Javadocs para nosotros.
2. Línea de comando
De forma predeterminada, Maven solo descarga el archivo JAR real de cada dependencia, no las fuentes ni los archivos de documentación.
Para descargar solo las fuentes , primero debemos navegar hasta el directorio que contiene el pom.xml y luego ejecutar el comando:
mvn dependency:sourcesLa descarga de las fuentes puede llevar un tiempo. De manera similar, para descargar solo los Javadocs, podemos emitir el comando :
mvn dependency:resolve -Dclassifier=javadocPor supuesto, también podemos descargar ambos en un comando:
mvn dependency:sources dependency:resolve -Dclassifier=javadocObviamente, si agregamos una nueva dependencia después de emitir estos comandos, tenemos que volver a emitir los comandos para descargar fuentes y Javadocs para la nueva dependencia.
3. Configuración de Maven
También es posible descargar fuentes y documentación en todo el sistema en todos los proyectos de Maven . Para hacer eso, debemos editar el archivo ~ / m2 / settings.xml o crear uno y agregarle la siguiente configuración:
downloadSources true true downloadSources Como se muestra arriba, estamos creando un perfil y activándolo de forma predeterminada. En este perfil, configuramos dos propiedades que le dicen a Maven que descargue las fuentes y la documentación. Además, Maven aplicará esta configuración a todos los proyectos.
4. El pom.xml
Incluso es posible poner esta configuración en pom.xml . De esta manera, obligamos a todos los colaboradores del proyecto a descargar las fuentes y la documentación como parte de la resolución de dependencia :
org.apache.maven.plugins maven-dependency-plugin 3.1.2 sources resolve javadoc Aquí, estamos configurando el complemento maven-dependency-plugin para descargar las fuentes y la documentación.
5. Configuración de IDE
También podemos configurar nuestros IDE favoritos para que lo hagan por nosotros. Por ejemplo, en IntelliJ IDEA, solo tenemos que ir a Preference> Build, Execution, Deployment> Build Tools> Maven> importar y marcar las casillas de verificación de fuentes y documentación:
6. Conclusión
En este tutorial rápido, vimos cómo descargar fuentes de dependencia y documentación en Maven de varias formas, que van desde soluciones de línea de comandos hasta configuraciones por proyecto o en todo el sistema.