4.gradlew机制和原理

大家好，欢迎来到IT知识分享网。

这篇文章简单了解一下为什么一行命令就能让项目运行起来或者打包出apk

首先我们平时打包时用的命令 ./gradlew assembleDebug ，其中的gradlew其实就是一个脚本文件，下面通过注释可以简单了解一下这个脚本的作用：

#!/usr/bin/env sh #   Gradle start up script for UN*X  # # Attempt to set APP_HOME # Resolve links: $0 may be a link # 第一个参数 $0 可能是一个 符号链接（Symlinks）默认都是没有使用符号链接的  PRG="$0" # Need this for relative symlinks. # while 递归获得当前执行文件的实际文件名  while [ -h "$PRG" ] ; do ls=`ls -ld "$PRG"` #尝试在 $ls 中找到并提取出符号链接的目标路径，并将其赋值给变量 link link=`expr "$ls" : '.*-> \(.*\)$'` #检查变量 $link 是否表示一个绝对路径（即以 / 开头） if expr "$link" : '/.*' > /dev/null; then PRG="$link" else PRG=`dirname "$PRG"`"/$link" fi done echo "$PRG" SAVED="`pwd`" # 切换到文件的实际地址 cd "`dirname \"$PRG\"`/" >/dev/null # 保存文件实际dir为APP_HOME APP_HOME="`pwd -P`" # 切回到刚才保存的$SAVED原文件夹 cd "$SAVED" >/dev/null APP_NAME="Gradle" #basename：这是一个 Unix/Linux 命令，用于从一个包含路径的字符串中提取出基本文件名。例如，如果输入的是 /path/to/my_script.sh，则 basename 会返回 my_script.sh。 APP_BASE_NAME=`basename "$0"` # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. # 在此处添加默认JVM选项。您还可以使用JAVA_OPTS和GRADLE_PTS将JVM选项传递给此脚本。 DEFAULT_JVM_OPTS="" # Use the maximum available, or set MAX_FD != -1 to use that value. MAX_FD="maximum" warn () { 
    echo "$*" } die () { 
    echo echo "$*" echo exit 1 } # OS specific support (must be 'true' or 'false'). # 判断操作系统 darwin是mac os cygwin=false msys=false darwin=false nonstop=false case "`uname`" in CYGWIN* ) cygwin=true ;; Darwin* ) darwin=true ;; MINGW* ) msys=true ;; NONSTOP* ) nonstop=true ;; esac # 设置CLASSPATH CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar # Determine the Java command to use to start the JVM. # 确定用于启动JVM的Java命令。 if [ -n "$JAVA_HOME" ] ; then if [ -x "$JAVA_HOME/jre/sh/java" ] ; then # IBM's JDK on AIX uses strange locations for the executables JAVACMD="$JAVA_HOME/jre/sh/java" else JAVACMD="$JAVA_HOME/bin/java" fi if [ ! -x "$JAVACMD" ] ; then die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME Please set the JAVA_HOME variable in your environment to match the location of your Java installation." fi else JAVACMD="java" which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. Please set the JAVA_HOME variable in your environment to match the location of your Java installation." fi # Increase the maximum file descriptors if we can. # 检查操作系统类型，如果不是 Cygwin、Darwin 或 NonStop if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ]; then # 获取系统支持的最大文件描述符数量，保存到 MAX_FD_LIMIT 变量中 MAX_FD_LIMIT=$(ulimit -H -n) # 如果上一条命令ulimit -H -n的返回值为0 if [ $? -eq 0 ]; then # 如果用户将 MAX_FD 设置为 "maximum" 或 "max"，则使用系统支持的最大文件描述符数量 if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ]; then MAX_FD="$MAX_FD_LIMIT" fi # 否则使用用户设置的 MAX_FD。 ulimit -n $MAX_FD if [ $? -ne 0 ]; then # 执行错误 报错 warn "Could not set maximum file descriptor limit: $MAX_FD" fi else warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" fi fi # For Darwin, add options to specify how the application appears in the dock # 如果是 macOS 则设置 Gradle 的启动参数用于指定应用程序在 macOS Dock 栏中显示的名称和图标 if $darwin; then GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" fi # For Cygwin, switch paths to Windows format before running java # cygpath命令将Unix格式的路径转换为Windows格式的路径 # 以下if代码块作用就是在Cygwin或MSYS下将路径转换成Windows格式后运行Java程序的。因为unix格式和windows路径格式不兼容，不再逐行解释 if $cygwin ; then # 用cygpath转换 APP_HOME=`cygpath --path --mixed "$APP_HOME"` CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` JAVACMD=`cygpath --unix "$JAVACMD"` # We build the pattern for arguments to be converted via cygpath ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` SEP="" for dir in $ROOTDIRSRAW ; do ROOTDIRS="$ROOTDIRS$SEP$dir" SEP="|" done OURCYGPATTERN="(^($ROOTDIRS))" # Add a user-defined pattern to the cygpath arguments if [ "$GRADLE_CYGPATTERN" != "" ] ; then OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" fi # Now convert the arguments - kludge to limit ourselves to /bin/sh i=0 for arg in "$@" ; do CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` CHECK2=`echo "$arg"|egrep -c "^-"`  Determine if an option if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then  Added a condition eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` else eval `echo args$i`="\"$arg\"" fi i=$((i+1)) done case $i in (0) set -- ;; (1) set -- "$args0" ;; (2) set -- "$args0" "$args1" ;; (3) set -- "$args0" "$args1" "$args2" ;; (4) set -- "$args0" "$args1" "$args2" "$args3" ;; (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; esac fi # Escape application args 转义应用程序参数 # 该函数的目的是将传入的参数逐个输出，并在每个参数两端添加单引号，以便在脚本中正确处理包含空格和其他特殊字符的参数。 save () { 
    for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done echo " " } # 调用save函数 $@:所有参数 APP_ARGS=$(save "$@") # Collect all arguments for the java command, following the shell quoting and substitution rules # 按照shell引用和替换规则，收集java命令的所有参数 # eval命令设置变量的语句 [DEFAULT_JVM_OPTS、JAVA_OPTS、GRADLE_OPTS、APP_BASE_NAME、CLASSPATH]组合成一个命令行参数，并将其与原始的命令行参数("$@")合并 eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" # by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong # 如果是mac系统，检查当前工作目录 ($PWD) 是否与用户主目录 ($HOME) 相同。如果这两个条件都满足，则将当前目录切换到脚本所在目录 if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then cd "$(dirname "$0")" fi # 执行java命令 执行java应用程序的主类org.gradle.wrapper.GradleWrapperMain的main方法（gradle-wrapper.jar中） exec "$JAVACMD" "$@" 

可以看到该脚本前面绝大部分都是对参数的检查传递和对操作系统平台兼容性的适配，其实最重要的、最主要的就是最后一行最终是通过java命令启动了java程序，并传递了参数。执行java应用程序的主类org.gradle.wrapper.GradleWrapperMain的main方法（gradle-wrapper.jar中）

GradleWrapperMain的main方法如下

public static void main(String[] args) throws Exception { 
    File wrapperJar = wrapperJar(); File propertiesFile = wrapperProperties(wrapperJar); File rootDir = rootDir(wrapperJar); CommandLineParser parser = new CommandLineParser(); parser.allowUnknownOptions(); parser.option(new String[]{ 
   "g", "gradle-user-home"}).hasArgument(); parser.option(new String[]{ 
   "q", "quiet"}); SystemPropertiesCommandLineConverter converter = new SystemPropertiesCommandLineConverter(); converter.configure(parser); ParsedCommandLine options = parser.parse(args); Properties systemProperties = System.getProperties(); systemProperties.putAll(converter.convert(options, new HashMap())); File gradleUserHome = gradleUserHome(options); addSystemProperties(gradleUserHome, rootDir); Logger logger = logger(options); WrapperExecutor wrapperExecutor = WrapperExecutor.forWrapperPropertiesFile(propertiesFile); wrapperExecutor.execute(args, new Install(logger, new Download(logger, "gradlew", wrapperVersion()), new PathAssembler(gradleUserHome)), new BootstrapMainStarter()); } 

大致做了如下工作：

1. 解析命令行参数：处理用户通过命令行传递给 Gradle Wrapper 的参数，如 -p 指定项目路径、 -b 指定构建脚本路径等。
2. 检查和下载 Gradle 发行版：如果本地没有指定版本的 Gradle 工具包，则根据配置文件（如 gradle-wrapper.properties）中的信息从远程仓库下载对应版本的 Gradle 发行版到本地缓存。
3. 设置环境变量和工作目录：为 Gradle 运行准备必要的环境变量，并确保正确的项目工作目录。
4. 启动实际的 Gradle 进程：使用已下载或已存在的 Gradle 可执行文件启动一个新的进程来执行实际的构建任务。通常会将原始命令行参数转发给这个新启动的 Gradle 进程。

这个新的gradle进程开始真正进行gradle的构建

gradle利用下面这个枚举描述了gradle的构建的状态

 private static enum Stage { 
    LoadSettings,//执行 settings.gradle(.kts) 文件，定义项目结构和要包含的子项目,然后创建对应的 project Configure,//解析并执行项目的 build.gradle(.kts) 构建脚本。 TaskGraph,//在配置阶段获取的各个任务及其依赖关系生成一个有向无环图 (DAG) RunTasks { 
   //按照任务图的拓扑排序顺序执行任务。 String getDisplayName() { 
    return "Build"; } }, Finished;//结束 private Stage() { 
    } String getDisplayName() { 
    return this.name(); } } 

还记得上一篇我们说gradle构建生命周期分为三个阶段 Initialization（初始化）、Configuration（配置）、Execution（执行）

可以看到和源码基本对应，大致就是 Initialization对应LoadSettings、Configuration对应Configure和TaskGraph、Execution对应RunTasks。

网上已经有很多人对以上各个阶段具体执行的源码进行了分析，有兴趣可以自行搜索查看。

至此就大概明白gradle构建的机制原理了，简单概括就是 我们通过gradlew启动了一个jvm进程，这个jvm进程会解析参数、检查和下载gradle、配置环境并最终启动真正的gradle进程，然后加载gradle脚本文件并按照规则执行。