Ruboto 2 技术文档

2024-12-20 23:04:47作者：董宙帆

本文档将详细介绍如何安装、使用 Ruboto 2，以及如何使用其 API。请按照以下指南进行操作。

1. 安装指南

首先，确保您的开发环境满足以下条件：

下载并安装 Android Studio。

接下来，按照以下步骤进行安装：

创建一个新项目：
- 在启动屏幕中选择 "Create New Project"。
- 选择 "Phone and Tablet" 和 "No Activity" 作为项目模板。
- 选择 "Java" 作为您的编程语言，并将 "Minimum SDK" 设置为 "API 27: Android 8.1 (Oreo)" 或更高。

在 settings.gradle 文件的 dependencyResolutionManagement/repositories 部分添加 jcenter：

dependencyResolutionManagement {
    ...
    repositories {
        ...
        jcenter()
    }
}

在 app/build.gradle 文件中添加以下依赖项：

dependencies {
  ...
  implementation fileTree(dir: 'libs', include: ['*.jar'])
  implementation 'com.linkedin.dexmaker:dexmaker:2.19.1'
  implementation 'me.qmx.jitescript:jitescript:0.4.1'
  implementation 'com.jakewharton.android.repackaged:dalvik-dx:7.1.0_r7'
}

添加 gems.rb 文件：

source 'https://rubygems.org/'

gem 'ruboto', '~>2.0.dev', git: 'https://github.com/ruboto/ruboto.git'

确保在命令行中使用 JRuby：

创建一个 .ruby-version 文件：
```
jruby
```
初始化 Ruboto：
```
jruby -S bundle
jruby -S bundle exec ruboto init
```
这将复制项目核心文件到您的项目。

在 app 目录下添加 gems.rb 文件：

source 'https://rubygems.org/'

gem 'activerecord', '~>7.0'
gem 'activerecord-jdbc-adapter', '~>70.1'
gem 'sqldroid', '~>1.0'

添加 app/update_jruby_jar.sh 脚本：

#!/usr/bin/env bash
set -e

VERSION="9.4.2.0"
FULL_VERSION="${VERSION}"
# FULL_VERSION="${VERSION}-SNAPSHOT" # 取消注释以使用本地快照
# FULL_VERSION="${VERSION}-20190822.050313-17" # 取消注释以使用远程快照
JAR_FILE="jruby-complete-${FULL_VERSION}.jar"
DOWNLOAD_DIR="$HOME/Downloads"
DOWNLOADED_JAR="${DOWNLOAD_DIR}/${JAR_FILE}"
SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )

cd $SCRIPT_DIR

[ ! -d $HOME/Downloads ] && mkdir $HOME/Downloads  # 如果目录不存在，创建目录
[ ! -d ./libs ] && mkdir ./libs                    # 如果目录不存在，创建目录

cd libs
rm -f bcpkix-jdk15on-*.jar bcprov-jdk15on-*.jar bctls-jdk15on-*.jar cparse-jruby.jar generator.jar jline-*.jar jopenssl.jar jruby-complete-*.jar parser.jar psych.jar readline.jar snakeyaml-*.jar

if test -f "${DOWNLOADED_JAR}"; then
  echo "找到下载的 JAR 文件"
else
  echo "未找到 ${DOWNLOADED_JAR} - 正在下载。"
  curl "https://oss.sonatype.org/service/local/repositories/releases/content/org/jruby/jruby-complete/${VERSION}/jruby-complete-${VERSION}.jar" -o "${DOWNLOADED_JAR}"
fi
cp ${DOWNLOADED_JAR} .

unzip -o -j ${JAR_FILE} '*.jar'

# FIXME(uwe): 为什么删除这些文件？
zip generator.jar -d json/ext/ByteListTranscoder.class
zip generator.jar -d json/ext/OptionsReader.class
zip generator.jar -d json/ext/Utils.class
zip generator.jar -d json/ext/RuntimeInfo.class

cd - >/dev/null

cd src/main/java
find * -type f | grep "org/jruby/" | sed -e 's/\.java//g' | sort > ../../../overridden_classes.txt
cd - >/dev/null

while read p; do
  unzip -Z1 libs/${JAR_FILE} | grep "$p\\.class" > classes.txt
  unzip -Z1 libs/${JAR_FILE} | egrep "$p(\\\$[^$]+)*\\.class" >> classes.txt
  if [[ -s classes.txt ]] ; then
    zip -d -@ libs/${JAR_FILE} <classes.txt
    if [[ ! "$?" == "0" ]] ; then
      zip -d libs/${JAR_FILE} "$p\\.class"
    fi
  fi
  rm classes.txt
done < overridden_classes.txt

rm overridden_classes.txt

cd libs
rm -f digest.jar
cd - >/dev/null

使 app/update_jruby_jar.sh 脚本可执行：
```
chmod u+x app/update_jruby_jar.sh
```
生成 jruby.jar：
```
app/update_jruby_jar.sh
```

生成启动活动：

bundle exec ruboto gen class Activity --name StartupActivity

将启动活动意图过滤器添加到 app/src/main/AndroidManifest.xml 中的新活动标签：

<activity android:name='StartupActivity' android:exported="true">
    <intent-filter>
        <action android:name="android.intent.action.MAIN" />
        <category android:name="android.intent.category.LAUNCHER" />
        <action android:name="android.intent.action.VIEW" />
    </intent-filter>
</activity>

在 app/src/main/AndroidManifest.xml 中声明 Ruboto 组件和 SplashActivity：

<activity android:name='org.ruboto.RubotoActivity' />
<activity android:name='org.ruboto.RubotoDialog' android:theme='@android:style/Theme.Dialog' />
<service
    android:name='org.ruboto.RubotoService'
    android:exported='false' />
<activity
    android:name='org.ruboto.SplashActivity'
    android:configChanges='orientation|screenSize'
    android:exported='false'
    android:noHistory='true' />