4.gradlew机制和原理

已于 2024-03-27 01:23:30 修改
阅读量1.8k 收藏 10
点赞数 23
分类专栏： gradle系列 文章标签： android gradle
于 2024-02-06 11:18:30 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_36017595/article/details/136053860
版权

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

我们创建好一个项目后，都可以在项目根目录找到gradle/wrapper文件夹里面有两个文件，已经gradlew和gradlew.bat 这两个脚本文件,如下：
在这里插入图片描述
gradlew、gradlew.bat 这两个脚本文件作用一样，只不过gradlew.bat 是在windows上面运行，gradlew则是在支持shell脚本的环境中运行，比如mac os、linux。（有关gradle-wrapper的介绍可以参考我的gradle系列的第一篇博客1.Gradle入门与基本配置）

首先我们平时打包时用的命令 ./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脚本文件并按照规则执行。

Android studio 环境问题
u010221508的博客
08-14 607
1 'gradlew' 不是内部或外部命令，也不是可运行的程序 或批处理文件。 发现一个项目的graldew命令不能用，而其他的gradlew命令是可以用的，经过对比发现，这个新的项目的目录里面没有gradlew.bat文件 2 FAILURE: Build failed with an exception. * What went wrong: Could not determine...
【Android Gradle 插件】Gradle 基础配置 ⑥ ( Android工程 Gradle 常用命令 | gradlew 可执行文件 | 查看帮助文档 | 查看应用依赖 )
浪漫之圣
01-22 601
在 Android Studio 工程中 , Gradle 构建完成后 , 也会自动生成 gradlew 和 gradlew.bat 两个可执行文件 , 前者是 Lunix/Mac 系统的 , 后者是 Windows 系统的;可以查看 Gradle 命令行工具 gradlew 的帮助文档;
android 项目缺少gradlew
weixin_40385755的博客
08-12 324
Android 项目缺少 gradlew 的解决方案 在进行 Android 项目开发时，遇到“缺少 gradlew”这一问题并不罕见。gradlew 是 Gradle Wrapper 的缩写，能够帮助我们以项目自身的版本下载和执行 Gradle，而不依赖于系统中的 Gradle 安装。这一机制提升了项目的可移植性，确保了...
深入解析 ./gradlew 脚本与 Gradle Wrapper 启动流程
最新发布
wy676579037的专栏
03-23 1590
在。
gradlew
相公
08-12 3805
gradlew 标签（空格分隔）： gradlew gradlew 先简单介绍一下： 下面的介绍简单来说就是gradle会快速迭代版本，如果合作开发项目会导致自己下载gradle版本不一，从而手忙脚乱，所以干脆包装起来，统一 转载自*一篇文章讲清楚Gradle与Gradle Wrapper的区别* 因为gradle处于快速迭代阶段，经常发布新版本，如果我们的项目直接去引用，那么更改版本等会变得无...
基于Java实现的饭堂小广播广播机制实训设计源码
02-14
本项目是一套基于Java语言开发的模拟饭堂小广播广播机制的实训设计源码，提供了实际操作中广播系统的工作原理和运作方式的完整体验。项目包含多个文件类型，涵盖了项目构建、配置、资源和代码等多个方面，共计39个...
APK自动打包
天边oofs的专栏
08-05 947
用Android Studio打包，每次等待软件启动都需要点时间。就想尝试能否进行自动打包，减少些不必要的时间。 一、.bat打包 批处理打包方式，要求Android Studio已经能够对工程进行打包。该方式实际上是使用命令替代在Android Studio中进行的打包按钮操作。 结合cocos2dx的demo,使用了.properties文件，进行配置加密key,sign，是否加密，打包路径...
gradlew是什么指令
03-15
最后，补充原理部分，说明gradlew如何下载指定版本的Gradle，以及相关配置文件的位置，帮助用户更深入理解。这样他们遇到问题时，可以检查gradle-wrapper.properties或处理下载问题。 要确保回答结构清晰，分点列出...
gradle-5.4.1-all.zip和gradle-5.4.1-bin.zip
08-28
Gradle是现代软件开发中的一个强大构建工具，尤其在Java生态系统中被广泛使用。它以其灵活性、可扩展性和高效的依赖...无论你是初学者还是经验丰富的开发者，理解Gradle的工作原理和使用方式都是提升开发效率的关键。
gradle-6.6.1-all.zip和gradle-6.6.1-bin.zip
08-28
它包含了Javadoc和源码，使得开发者可以深入理解Gradle的工作原理，便于调试和扩展Gradle插件。 2. **Gradle-6.6.1-bin.zip**: 这个压缩包是精简版的Gradle发行包，仅包含运行Gradle所需的最小必要组件，如二进制...
gradle是什么和它的作用?
gepengmiss的博客
10-24 2817
gradle 是一个构建工具, 为gradle指定规则, 构建app, 包括编译、打包. Android Studio中默认就使用Gradle来完成应用的构建. 参考链接:https://www.cnblogs.com/Bonker/p/5619458.html ...
gradlew 命令说明
极客驿站
03-31 6742
gradlew 命令 快速构建命令 查看所有任务 ./gradlew tasks --all gradlew命令都可以使用简写，例如： ./gradlew assembleRelease 简写为：./gradlew aR 查看项目的依赖都依赖了哪些库。 gradlew :app:dependencies 只编译清单文件，并查看具体日志，快速定位清单文件报错 gradlew :app:processDebugManifest --stacktrace： 清除build文件夹
gradle与gradlew
qq_32087583的博客
01-30 436
Gradle Wrapper 允许项目在没有预先安装Gradle 的情况下运行，它会自动下载和使用与项目兼容的 Gradle 版本。通过使用 Gradle Wrapper，可以确保项目在不同的开发环境中能够使用相同版本的 Gradle，从而提供更好的一致性和可移植性。它使用 Groovy 或 Kotlin 编写的构建脚本，可以管理项目的依赖关系、编译代码、运行测试、打包应用程序等。使用 gradlew 命令时，它会自动检查并下载项目所需的 Gradle 版本（如果尚未下载），并使用该版本执行构建任务。
Gradle
123456789
08-16 982
Gradle Wrapper 是一个用于管理 Gradle 版本的工具，它使用该配置文件来指定要下载和使用的特定 Gradle 版本。总的来说，Groovy是一门功能丰富的编程语言，可以与Java无缝集成，并提供了许多便利的特性和工具，使得开发更加高效和愉快。Gradle Wrapper是一个用于下载和运行特定版本Gradle的脚本，它可以使你的项目保证使用相同的Gradle版本，无论在何处构建。上的文档，查找与你使用的Android Gradle插件版本相对应的Gradle插件版本。
gradlew 打包
nzw31的博客
01-26 434
/gradlew -v 版本号 ./gradlew clean 清除app目录下的build文件夹 ./gradlew build 检查依赖并编译打包,把debug、release环境的包都打出来             如果正式发布只需要打Release的包，用命令：assemble ./gradlew assembleDebug 编译并打Debug包 ./gradlew assemb
gradlew在基于Gradle项目构建中的应用分析
Roger_CX的博客
07-06 323
众所周知，在软件开发中，我们无论使用何种工具、库和软件，首先要做的事情就是先将所需的工具下载到本地，然后可能还需要进行一些基本的配置才能够正常使用。比如说，使用Maven进行项目构建，那首先就需要到http://maven.apache.org网站上将Maven二进制包下载下来、解压...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值