使用Toast作為例子。實現(xiàn)的功能是可以在JavaScript里寫ToastAndroid.show('Awesome', ToastAndroid.SHORT)來顯示一個Toast通知。
代碼:https://github.com/future-challenger/react-native-gaode-map
創(chuàng)建一個原生模塊
創(chuàng)建一個類,繼承ReactContextBaseJavaModule。
public class ToastModule extends ReactContextBaseJavaModule {
private static final String DURATION_SHORT_KEY = "SHORT";
private static final String DURATION_LONG_KEY = "LONG";
public ToastModule(ReactApplicationContext reactContext) {
super(reactContext);
}
}
之后需要實現(xiàn)一個方法getName。
@Override
public String getName() {
return "AnotherToastAndroid"; // 不能返回ToastAndroid,這個會報錯,或者需要手動指定覆蓋RN已有的實現(xiàn)。
}
這個方法必須實現(xiàn)。它的返回值是React Native的js部分調(diào)用模塊時的名稱。另外,如果這個方法返回的字符串包含RCT的話,那么RCT會被去掉。也就是,如果getName返回的是RCTToastAndroid的話,在js調(diào)用的時候還是使用ToastAndroid。
接下來實現(xiàn)show方法。
@ReactMethod
public void show(String message, int duration) {
Toast.makeText(getReactApplicationContext(), message, duration).show();
}
注意:模塊要導(dǎo)出方法給js使用,那么這個方法上必須使用@ReactMethod注解!并且返回值必須為void。如果要返回值的話,需要使用回調(diào)方法或者注冊事件。這些下文會講到。
方法的參數(shù)類型
在導(dǎo)出給js的方法中添加參數(shù)的時候,只能使用部分類型(java -> javascript):
Boolean -> Bool
Integer -> Number
Double -> Number
Float -> Number
String -> String
Callback -> function
ReadableMap -> Object
ReadableArray -> Array
注冊模塊
注冊模塊之后就可以使用。如果你的App里沒有Package類,那就自己創(chuàng)建一個。比如本例,就可以創(chuàng)建名為ToastReactPackage的Package類,該類實現(xiàn)ReactPackage接口。
public class ToastReactPackage implements ReactPackage {
@Override
public List<NativeModule> createNativeModules(ReactApplicationContext reactContext) {
return null;
}
@Override
public List<Class<? extends JavaScriptModule>> createJSModules() {
return null;
}
@Override
public List<ViewManager> createViewManagers(ReactApplicationContext reactContext) {
return null;
}
}
類中每個方法的名稱已經(jīng)明確的表明了其本身的作用。我們這里導(dǎo)出的是一個模塊,所以需要實現(xiàn)createNativeModules方法。其他的方法只要返回一個空列表就可以。最后的ToastReactPackage類的實現(xiàn)是:
public class ToastReactPackage implements ReactPackage {
@Override
public List<NativeModule> createNativeModules(ReactApplicationContext reactContext) {
List<NativeModule> modules = new ArrayList<>();
modules.add(new ToastModule(reactContext));
return modules;
}
@Override
public List<Class<? extends JavaScriptModule>> createJSModules() {
return Collections.emptyList();
}
@Override
public List<ViewManager> createViewManagers(ReactApplicationContext reactContext) {
return Collections.emptyList();
}
}
最后在MainApplication的getPackages方法里注冊Package。
public class MainApplication extends Application implements ReactApplication {
private final ReactNativeHost mReactNativeHost = new ReactNativeHost(this) {
@Override
public boolean getUseDeveloperSupport() {
return BuildConfig.DEBUG;
}
@Override
protected List<ReactPackage> getPackages() {
return Arrays.<ReactPackage>asList(
new MainReactPackage(),
new ToastReactPackage() // 這一句用來注冊我們的AnotherToastAndroid模塊
);
}
};
在React Native中使用模塊。
import {
//...
NativeModules,
PixelRatio,
} from 'react-native';
let AnotherToastAndroid = NativeModules.AnotherToastAndroid;
export default class mobike extends Component {
render() {
return (
<View style={styles.container}>
<TouchableOpacity style={styles.button} onPress={() => {
AnotherToastAndroid.show('Another Toast', AnotherToastAndroid.LONG);
}}>
<Text style={{ textAlign: 'center', }}>
Show Toast
</Text>
</TouchableOpacity>
</View>
);
}
}
不直接相關(guān)的內(nèi)容就隱藏掉了。使用的時候只要在import中引入NativeModules,之后在let AnotherToastAndroid = NativeModules.AnotherToastAndroid;提取我們的原生模塊。這個模塊的名字就是在Android模塊getName方法里返回的名稱AnotherToastAndroid。
之后在TouchableOpacity的onPress事件中調(diào)用AnotherToastAndroid的show方法。
至此,我們之前說的功能就都實現(xiàn)了。
返回常量
前面的內(nèi)容要運行起來還差這個一環(huán)。返回常量,你看到j(luò)s代碼里有這樣的調(diào)用:
AnotherToastAndroid.show('Another Toast', AnotherToastAndroid.LONG);
有這么一句:AnotherToastAndroid.LONG。要使用LONG,還有沒有用到的SHORT常量,需要原生模塊返回這樣的常量。
@Nullable
@Override
public Map<String, Object> getConstants() {
// return super.getConstants();
final Map<String, Object> constants = new HashMap<>();
constants.put(DURATION_SHORT_KEY, Toast.LENGTH_SHORT);
constants.put(DURATION_LONG_KEY, Toast.LENGTH_LONG);
return constants;
}
方法getConstants是類ReactContextBaseJavaModule的一個可選方法,專門用來返回常量。返回的內(nèi)容就是字典Map<String, Object>。
現(xiàn)在Demo可以運行起來了。
回調(diào)方法
前文說道,要返回值給js就需要用回調(diào)方法。現(xiàn)在看看在原生里如何實現(xiàn)這一點:
@ReactMethod
public void currentThreadName(Callback errorCallback, Callback successCallback) {
try {
String tn = Thread.currentThread().getName();
successCallback.invoke(tn);
} catch(Exception e) {
errorCallback.invoke(e.getMessage());
}
}
在Toast模塊里加了一個獲取當(dāng)前線程的方法。Android的這個導(dǎo)出回調(diào)方法看起來還是有點奇怪。本來應(yīng)該是一個回調(diào)返回兩個參數(shù):一個error,一個結(jié)果。這里用了兩個Callback,可能也是條件限制吧。
看看js如何使用:
<Button
style={{ marginTop: 10, }}
title='use callback'
pressHandler={
() => {
AnotherToastAndroid.currentThreadName((msg) => console.log(`error message ${msg}`)
, (threadName) => {
Alert.alert('Thread Name', `thread nane: ${threadName}`, null);
});
}}
/>
Promise
回調(diào)缺點很明顯。所以多數(shù)的時候都會選擇使用Promise。再加上現(xiàn)在流行的async-await就更多的人使用Promise了。
@ReactMethod
public void currentThreadNameByPromise(Promise promise) {
try {
String tn = Thread.currentThread().getName();
promise.resolve(tn);
} catch (Exception e) {
promise.reject("Thread Error", e);
}
}
來看看如何使用Promise的:
<Button
style={{ marginTop: 10, }}
title='use Promise'
pressHandler={
() => {
AnotherToastAndroid.currentThreadNameByPromise().then((threadName) =>
Alert.alert('Thread Name', `thread nane: ${threadName}`, null)
).catch(err => Alert.alert('Thread Name', `get thread nane error: ${err.message}`, null));
}}
/>
這些知識在一般的使用中就足夠了,如果需要更復(fù)雜的內(nèi)容可以查看官方文檔。我也會在之后補齊這部分的內(nèi)容。