Skip to content

Commit 536ed1a

Browse files
committed
项目改为gradle构建,作为library推送到maven central 版本v1.1
1 parent b6aa04f commit 536ed1a

File tree

30 files changed

+2812
-2264
lines changed

30 files changed

+2812
-2264
lines changed

README.md

Lines changed: 66 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,33 @@
11
Safe Java-JS WebView Bridge
22
===================
3-
抛弃使用高风险的WebView addjavascriptInterface方法,利用onJsPrompt解析纯JSON字符串,来实现网页JS层反射调用Java方法,同时通过对js层调用函数及回调函数的包装,支持方法参数传入所有已知的类型,包括number、string、boolean、object、function。
3+
抛弃使用高风险的WebView addJavascriptInterface方法,利用onJsPrompt解析纯JSON字符串,来实现网页JS层反射调用Java方法,同时通过对js层调用函数及回调函数的包装,支持方法参数传入所有已知的类型,包括number、string、boolean、object、function。
44

5-
## 如何开始
5+
## 安装
6+
使用Safe Java-JS WebView Bridge最简单的办法就是像下面这样添加项目依赖。
7+
8+
**Maven**
9+
10+
<dependency>
11+
<groupId>cn.pedant.safewebviewbridge</groupId>
12+
<artifactId>library</artifactId>
13+
<version>1.1</version>
14+
<type>aar</type>
15+
</dependency>
16+
17+
**Gradle**
18+
19+
repositories {
20+
mavenCentral()
21+
}
22+
23+
dependencies {
24+
compile 'cn.pedant.safewebviewbridge:library:1.1'
25+
}
26+
27+
28+
## 用法
29+
30+
### 如何开始
631
初始化Webview WebSettings时允许js脚本执行,同时使用你的注入名和注入类来实例化一个**InjectedChromeClient**对象,然后关联到你的Webview实例。如demo中的例子(页面中引用的对象名为HostApp,指定的注入类为HostJsScope):
732

833
WebView wv = new WebView(this);
@@ -12,16 +37,47 @@ Safe Java-JS WebView Bridge
1237
new InjectedChromeClient("HostApp", HostJsScope.class)
1338
);
1439
wv.loadUrl("file:///android_asset/test.html");
15-
16-
## 方法的定义
17-
需要注入到网页的方法,**必须在注入类中定义为public static且第一个参数接收Webview**,其他参数的类型可以是int、long、double、boolean、String、JSONObject、JsCallback。方法执行时会默认将当前Webview的实例放到第一个参数,所以你的定义可能看起来像这样子的:
40+
41+
### 自定义WebChromeClient子类
42+
如果你需要实现自己的WebChromeClient子类,然后设置到WebView。为了保持InjectedChromeClient的功能,你需要将此类继承自InjectedChromeClient,同时像下面这样覆盖这三个方法。
43+
44+
public class CustomChromeClient extends InjectedChromeClient {
45+
46+
public CustomChromeClient (String injectedName, Class injectedCls) {
47+
super(injectedName, injectedCls);
48+
}
49+
50+
@Override
51+
public boolean onJsAlert(WebView view, String url, String message, final JsResult result) {
52+
// to do your work
53+
// ...
54+
return super.onJsAlert(view, url, message, result);
55+
}
56+
57+
@Override
58+
public void onProgressChanged (WebView view, int newProgress) {
59+
super.onProgressChanged(view, newProgress);
60+
// to do your work
61+
// ...
62+
}
63+
64+
@Override
65+
public boolean onJsPrompt(WebView view, String url, String message, String defaultValue, JsPromptResult result) {
66+
// to do your work
67+
// ...
68+
return super.onJsPrompt(view, url, message, defaultValue, result);
69+
}
70+
}
71+
72+
### 方法的定义
73+
需要注入到网页的方法,**必须在注入类中定义为public static且第一个参数接收WebView**,其他参数的类型可以是int、long、double、boolean、String、JSONObject、JsCallback。方法执行时会默认将当前Webview的实例放到第一个参数,所以你的定义可能看起来像这样子的:
1874

1975
public static void testA (WebView webView) {}
2076
网页调用如下:
2177

2278
HostApp.testA();
2379

24-
## 方法的重载
80+
### 方法的重载
2581
在定义时,支持不同参数类型或参数个数的方法重载,如:
2682

2783
public static int overloadMethod(WebView view, int val) {
@@ -43,12 +99,12 @@ Safe Java-JS WebView Bridge
4399
}
44100
上面这三个方法并没有发生重载,HostApp.overloadMethod(1)调用时只会调用最后一个定义的方法(double类型定义的那个)。
45101

46-
## 方法的返回值
102+
### 方法的返回值
47103
Java层方法可以返回void 或 能转为字符串的类型(如int、long、String、double、float等)或 **可序列化的自定义类型**。关于自定义类型的返回可以参见Demo下“从Java层返回Java对象”项对HostApp.retJavaObject()的调用。另外如果方法定义时返回void,那么网页端调用得到的返回值为null。
48104

49105
如果方法执行过程中出现异常,那么在网页JS端会抛出异常,可以catch后打印详细的错误说明。
50106

51-
## 关于异步回调
107+
### 关于异步回调
52108
举例说明,首先你可以在Java层定义如下方法,该方法的作用是延迟设定的时间之后,用你传入的参数回调Js函数:
53109

54110
public static void delayJsCallBack(WebView view, int ms, final String backMsg, final JsCallback jsCallback) {
@@ -74,12 +130,12 @@ Java层方法可以返回void 或 能转为字符串的类型(如int、long、
74130
...
75131
}
76132

77-
## 发布时防混淆
133+
### 发布时防混淆
78134
注意注入类中的方法名称不能被混淆,否则页面会调用失败。故发布时需在你的混淆配置文件中加入注入类的防混淆代码,如demo中的HostJsScope配置:
79135

80136
-keepclassmembers class cn.pedant.SafeWebViewBridge.demo.HostJsScope{ *; }
81137

82-
## 小心过大数字
138+
### 小心过大数字
83139
JS中使用过大数字时,可能会导致精度丢失或者错误的数字结果,如下面:
84140

85141
HostApp.passLongType(14102300951321235)

build.gradle

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
buildscript {
2+
repositories {
3+
mavenCentral()
4+
}
5+
dependencies {
6+
classpath 'com.android.tools.build:gradle:0.13.2'
7+
}
8+
}
9+
10+
ext {
11+
compileSdkVersion = 17
12+
buildToolsVersion = "19.1.0"
13+
}
14+
15+
allprojects {
16+
repositories {
17+
mavenCentral()
18+
}
19+
}

gradle.properties

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
VERSION_NAME=1.1
2+
VERSION_CODE=2
3+
GROUP=cn.pedant.safewebviewbridge
4+
5+
POM_DESCRIPTION=Provide a safe and reliable scheme for Java and JavaScript in Android WebView.
6+
POM_URL=https://github.com/pedant/safe-java-js-webview-bridge
7+
POM_SCM_URL=https://github.com/pedant/safe-java-js-webview-bridge
8+
POM_SCM_CONNECTION=scm:[email protected]:pedant/safe-java-js-webview-bridge.git
9+
POM_SCM_DEV_CONNECTION=scm:[email protected]:pedant/safe-java-js-webview-bridge.git
10+
POM_LICENCE_NAME=The MIT License
11+
POM_LICENCE_URL=http://opensource.org/licenses/MIT
12+
POM_LICENCE_DIST=repo
13+
POM_DEVELOPER_ID=pedant
14+
POM_DEVELOPER_NAME=Pedant

gradle/wrapper/gradle-wrapper.jar

48.7 KB
Binary file not shown.
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
#Wed Apr 10 15:27:10 PDT 2013
2+
distributionBase=GRADLE_USER_HOME
3+
distributionPath=wrapper/dists
4+
zipStoreBase=GRADLE_USER_HOME
5+
zipStorePath=wrapper/dists
6+
distributionUrl=https\://services.gradle.org/distributions/gradle-2.1-all.zip

gradlew

Lines changed: 164 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,164 @@
1+
#!/usr/bin/env bash
2+
3+
##############################################################################
4+
##
5+
## Gradle start up script for UN*X
6+
##
7+
##############################################################################
8+
9+
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
10+
DEFAULT_JVM_OPTS=""
11+
12+
APP_NAME="Gradle"
13+
APP_BASE_NAME=`basename "$0"`
14+
15+
# Use the maximum available, or set MAX_FD != -1 to use that value.
16+
MAX_FD="maximum"
17+
18+
warn ( ) {
19+
echo "$*"
20+
}
21+
22+
die ( ) {
23+
echo
24+
echo "$*"
25+
echo
26+
exit 1
27+
}
28+
29+
# OS specific support (must be 'true' or 'false').
30+
cygwin=false
31+
msys=false
32+
darwin=false
33+
case "`uname`" in
34+
CYGWIN* )
35+
cygwin=true
36+
;;
37+
Darwin* )
38+
darwin=true
39+
;;
40+
MINGW* )
41+
msys=true
42+
;;
43+
esac
44+
45+
# For Cygwin, ensure paths are in UNIX format before anything is touched.
46+
if $cygwin ; then
47+
[ -n "$JAVA_HOME" ] && JAVA_HOME=`cygpath --unix "$JAVA_HOME"`
48+
fi
49+
50+
# Attempt to set APP_HOME
51+
# Resolve links: $0 may be a link
52+
PRG="$0"
53+
# Need this for relative symlinks.
54+
while [ -h "$PRG" ] ; do
55+
ls=`ls -ld "$PRG"`
56+
link=`expr "$ls" : '.*-> \(.*\)$'`
57+
if expr "$link" : '/.*' > /dev/null; then
58+
PRG="$link"
59+
else
60+
PRG=`dirname "$PRG"`"/$link"
61+
fi
62+
done
63+
SAVED="`pwd`"
64+
cd "`dirname \"$PRG\"`/" >&-
65+
APP_HOME="`pwd -P`"
66+
cd "$SAVED" >&-
67+
68+
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
69+
70+
# Determine the Java command to use to start the JVM.
71+
if [ -n "$JAVA_HOME" ] ; then
72+
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
73+
# IBM's JDK on AIX uses strange locations for the executables
74+
JAVACMD="$JAVA_HOME/jre/sh/java"
75+
else
76+
JAVACMD="$JAVA_HOME/bin/java"
77+
fi
78+
if [ ! -x "$JAVACMD" ] ; then
79+
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
80+
81+
Please set the JAVA_HOME variable in your environment to match the
82+
location of your Java installation."
83+
fi
84+
else
85+
JAVACMD="java"
86+
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
87+
88+
Please set the JAVA_HOME variable in your environment to match the
89+
location of your Java installation."
90+
fi
91+
92+
# Increase the maximum file descriptors if we can.
93+
if [ "$cygwin" = "false" -a "$darwin" = "false" ] ; then
94+
MAX_FD_LIMIT=`ulimit -H -n`
95+
if [ $? -eq 0 ] ; then
96+
if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
97+
MAX_FD="$MAX_FD_LIMIT"
98+
fi
99+
ulimit -n $MAX_FD
100+
if [ $? -ne 0 ] ; then
101+
warn "Could not set maximum file descriptor limit: $MAX_FD"
102+
fi
103+
else
104+
warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
105+
fi
106+
fi
107+
108+
# For Darwin, add options to specify how the application appears in the dock
109+
if $darwin; then
110+
GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
111+
fi
112+
113+
# For Cygwin, switch paths to Windows format before running java
114+
if $cygwin ; then
115+
APP_HOME=`cygpath --path --mixed "$APP_HOME"`
116+
CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
117+
118+
# We build the pattern for arguments to be converted via cygpath
119+
ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
120+
SEP=""
121+
for dir in $ROOTDIRSRAW ; do
122+
ROOTDIRS="$ROOTDIRS$SEP$dir"
123+
SEP="|"
124+
done
125+
OURCYGPATTERN="(^($ROOTDIRS))"
126+
# Add a user-defined pattern to the cygpath arguments
127+
if [ "$GRADLE_CYGPATTERN" != "" ] ; then
128+
OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
129+
fi
130+
# Now convert the arguments - kludge to limit ourselves to /bin/sh
131+
i=0
132+
for arg in "$@" ; do
133+
CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
134+
CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
135+
136+
if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
137+
eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
138+
else
139+
eval `echo args$i`="\"$arg\""
140+
fi
141+
i=$((i+1))
142+
done
143+
case $i in
144+
(0) set -- ;;
145+
(1) set -- "$args0" ;;
146+
(2) set -- "$args0" "$args1" ;;
147+
(3) set -- "$args0" "$args1" "$args2" ;;
148+
(4) set -- "$args0" "$args1" "$args2" "$args3" ;;
149+
(5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
150+
(6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
151+
(7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
152+
(8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
153+
(9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
154+
esac
155+
fi
156+
157+
# Split up the JVM_OPTS And GRADLE_OPTS values into an array, following the shell quoting and substitution rules
158+
function splitJvmOpts() {
159+
JVM_OPTS=("$@")
160+
}
161+
eval splitJvmOpts $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS
162+
JVM_OPTS[${#JVM_OPTS[*]}]="-Dorg.gradle.appname=$APP_BASE_NAME"
163+
164+
exec "$JAVACMD" "${JVM_OPTS[@]}" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "$@"

0 commit comments

Comments
 (0)