maven & gradle

brook

2018-01-09

maven

snippet

maven

config

1 2	# macos /opt/homebrew/Cellar/maven/3.9.9/libexec/conf/settings.xml

command

mvn compile 编译,将Java 源程序编译成 class 字节码文件。
mvn test 测试，并生成测试报告
mvn clean 将以前编译得到的旧的 class 字节码文件删除
mvn pakage 打包,动态 web工程打 war包，Java工程打 jar 包。
mvn install 将项目生成 jar 包放在仓库中，以便别的模块调用
Maven的几个常用plugin

other

# package
mvn clean package -DskipTests

# init project
mvn archetype:generate -DgroupId=brook.hbase -DartifactId=hbase-client -DarchetypeArtifactId=maven-archetype-quickstart -DarchetypeVersion=1.4 -DinteractiveMode=false

# run sprint-boot project
mvn spring-boot:run

scope

compile
默认就是compile，什么都不配置也就是意味着compile。compile表示被依赖项目需要参与当前项目的编译，当然后续的测试，运行周期也参与其中，是一个比较强的依赖。打包的时候通常需要包含进去。
test
scope为test表示依赖项目仅仅参与测试相关的工作，包括测试代码的编译，执行。比较典型的如junit。
runtime
runntime表示被依赖项目无需参与项目的编译，不过后期的测试和运行周期需要其参与。与compile相比，跳过编译而已，说实话在终端的项目（非开源，企业内部系统）中，和compile区别不是很大。比较常见的如JSR×××的实现，对应的API jar是compile的，具体实现是runtime的，compile只需要知道接口就足够了。oracle jdbc驱动架包就是一个很好的例子，一般scope为runntime。另外runntime的依赖通常和optional搭配使用，optional为true。我可以用A实现，也可以用B实现。
provided
provided意味着打包的时候可以不用包进去，别的设施(Web Container)会提供。事实上该依赖理论上可以参与编译，测试，运行等周期。相当于compile，但是在打包阶段做了exclude的动作。
system
从参与度来说，和provided相同，不过被依赖项不会从maven仓库抓，而是从本地文件系统拿，一定需要配合systemPath属性使用

solution

多项目之间相互引用

应该在父目录下进行maven install操作，会自动生成子模块的jar或war包。

解决maven无法加载本地lib/下的jar包问题(程序包XXX不存在)

原因

若该程序包是第三方的jar，解决方案是让maven既加载maven库中的jar包，又要加载本地WEB-INF/lib下的jar包。

解决

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-compiler-plugin</artifactId>
    <version>3.6.0</version>
    <configuration>
        <source>1.8</source>
        <target>1.8</target>
        <encoding>UTF-8</encoding>
        <compilerArguments>
            <extdirs>${project.basedir}/src/main/webapp/WEB-INF/lib</extdirs>
        </compilerArguments>
    </configuration>
</plugin>

创建本地引用包

直接引用本地jar

将jar放在项目中，例如web项目就放在 webapp/WEB-INF/lib下面
然后再pom.xml中添加jar的依赖：

<dependency>
    <groupId>myjar</groupId>
    <artifactId>myjar</artifactId>
    <version>1.0.0</version>
    <scope>system</scope>
    <systemPath>${project.basedir}/path/to/myjar-1.0.0.jar</systemPath>
</dependency>

安装到本地仓库

mvn install:install-file -Dfile=xxx.jar -DgroupId=xx.xxx.xx -DartifactId=xx -Dversion=xx -Dpackaging=jar

参数说明:
-DgroupId:对应dependency的groupId
-DartifactId:对应dependency的artifactId
-Dversion:对应dependency中的version
-Dpackaging:安装的类型，jar或者pom
-Dfile:要安装的jar文件的路径

依赖传递原则

几乎所有的Jar包冲突都和依赖传递原则有关，所以我们先说Maven中的依赖传递原则：

最短路径优先原则

假如引入了2个Jar包A和B，都传递依赖了Z这个Jar包：

A -> X -> Y -> Z(2.5)
B -> X -> Z(2.0)

那其实最终生效的是Z(2.0)这个版本。因为他的路径更加短。如果我本地引用了Z(3.0)的包，那生效的就是3.0的版本。一样的道理。

最先声明优先原则

如果路径长短一样，优先选最先声明的那个。

A -> Z(3.0)
B -> Z(2.5)

这里A最先声明，所以传递过来的Z选择用3.0版本的。

add git info into package

<plugin>
  <groupId>pl.project13.maven</groupId>
  <artifactId>git-commit-id-plugin</artifactId>
  <version>2.2.4</version>
  <executions>
    <execution>
      <id>get-the-git-infos</id>
      <goals>
        <goal>revision</goal>
      </goals>
    </execution>
  </executions>
  <configuration>
    <dotGitDirectory>${project.basedir}/.git</dotGitDirectory>
    <prefix>git</prefix>
    <verbose>false</verbose>
    <generateGitPropertiesFile>true</generateGitPropertiesFile
  <generateGitPropertiesFilename>${project.build.outputDirectory}/git.properties</generateGitPropertiesFilename>
    <format>json</format>
    <gitDescribe>
      <skip>false</skip>
      <always>false</always>
      <dirty>-dirty</dirty>
    </gitDescribe>
  </configuration>
</plugin>

生成的git.properties会在jar包位置 BOOT-INF/classes/git.properties

publish

remote repo

step1: config /path/to/maven/conf/settings.xml

<settings>
  <servers>
    <server>
      <id>central</id>
      <username>xxx</username>
      <password>xxx</password>
    </server>
  </servers>
 ......
  <profiles>
   <profile>
     <id>gpg-key</id>
     <properties>
         <gpg.keyname>xxx</gpg.keyname>
         <gpg.passphrase>xxx</gpg.passphrase>
     </properties>
   </profile>
  </profiles>
  <activeProfiles>
    <activeProfile>gpg-key</activeProfile>
  </activeProfiles>
</settings>

需要保证keyid对应的secret key在服务器上已存在，如不存在，需要进行import

gpg –armor –export-secret-keys xxx > secret-key.asc # 原有机器

gpg –import secret-key.asc # 导入机器

检验： gpg –list-keys –keyid-format LONG

注意：如果是普通用户导入secret key，需要在tmux中进行导入，因为非tmux环境 The terminal device (TTY, e.g., /dev/pts/X) is not owned by the user running GPG. Check with ls -l $(tty)，因为只用当前拥有TTY权限，才可以This ensures GPG agent can access the terminal and has permission to generate the key.

step2: publish

1	mvn clean deploy -DskipTests # -Pgpg-key

local repo

troubleshooting

idea中的maven模块变成灰色的可能原因
jar包和war包的介绍与区别
由于没有mvn install操作，没有在本地下载依赖包到lib目录下，所以启动项目，会提示java.lang.ClassNotFoundException: org.springframework.web.context.ContextLoaderListener错误

gradle

command

# Upgrade Gradle Version in a Java Project
./gradlew wrapper --gradle-version x.y.z

# check plugin version
./gradlew buildEnvironment

# diagnostic
./gradlew xxx --stacktrace

daemon

# check daemons 
./gradlew --status

# stops all Gradle daemons of the same Gradle version used by the wrapper.
./gradlew --stop

task

1 2	# list tasks /gradlew tasks # --all

build

# download dependency
./gradlew dependencies

# skip test
./gradlew clean build -x test

# build specify submodule
./gradlew :dingo-executor:build -x test

publish

plugin: com.vanniktech.maven.publish

remote repo

# offical
https://vanniktech.github.io/gradle-maven-publish-plugin/central/

# publish
./gradlew publishToMavenCentral  # --stacktrace

config secret

optional 1: gradle.properties

mavenCentralUsername=username
mavenCentralPassword=the_password

signing.keyId=12345678
signing.password=some_password
signing.secretKeyRingFile=/Users/yourusername/.gnupg/secring.gpg

optional 2: env

ORG_GRADLE_PROJECT_mavenCentralUsername=username
ORG_GRADLE_PROJECT_mavenCentralPassword=the_password

# short key id
ORG_GRADLE_PROJECT_signingInMemoryKey=exported_ascii_armored_key  
# Optional
ORG_GRADLE_PROJECT_signingInMemoryKeyId=12345678
# If key was created with a password.
ORG_GRADLE_PROJECT_signingInMemoryKeyPassword=some_password

tip

1
2
3

# signing.keyId 是取8位 short keyid, 
# the 8-character short form of  PGP key ID. For example, if full key ID is 633B1F30DF975148, the short form would be DF975148.
signing.keyId=DF975148

local repo

1	./gradlew publishToMavenLocal

build.gradle

mavenPublishing {
  publishToMavenCentral()
	if (gradle.startParameter.taskNames.any { it.contains('MavenCentral') || it.contains('publishToMavenCentral') }) {
        signAllPublications()
    }
}