React Native Android原生模块使用(获取Android手机通讯录的数据)

Stella981
• 阅读 686

使用React Native开发App时会遇到需要用到一些Android原生模块,比如:访问相册、通讯录、日历等等。下面主要是以获取Android手机通讯录的数据为例,讲解React Native Android原生模块的使用。

React Native  Android原生模块使用(获取Android手机通讯录的数据)

注:数据格式可自行做修改。

React Native Android原生模块的主要流程

 在这里我将构建React Native Android原生模块的流程划分为两大步:

      1.编写Android原生模块的相关Java代码;

      2.注册与导出React Native原生模块

编写Android原生模块的相关Java代码

我们需要用到Android Studio。 首先我们用Android Studio打开React Native项目根目录下的android目录。项目初始化成功之后在Android Studio的工具栏中可以看到一个名为“app”的一个可运行的模块(注:用Android Studio第一次打开这个Android项目的时候,Android Studio会下载一些此项目所需要的依赖,比如项目所依赖的Gradle版本等)

React Native  Android原生模块使用(获取Android手机通讯录的数据)

接下来呢,我们开始编写Java代码。

1.创建一个ContactInfo.java(用于实现获取Android手机通讯录数据的功能)

import android.Manifest; import android.app.Activity; import android.content.ContentResolver; import android.content.Context; import android.content.pm.PackageManager; import android.database.Cursor; import android.net.Uri; import android.os.SystemClock; import android.text.TextUtils; import android.widget.Toast;

import com.facebook.react.bridge.Promise; import com.nativedemo.utils.PermissionUtils;

import org.json.JSONArray; import org.json.JSONException; import org.json.JSONObject;

import java.lang.ref.WeakReference;

public class ContactInfo { private static WeakReference mActivity; private static Promise mPromise;

public static void init(Activity activity) {
    if (activity == null) return;
    mActivity = new WeakReference<>(activity);
}
//获取通讯录
public static void getContactInfo(Context context, Promise promise){
    if (context==null||mActivity==null){
        promise.reject("获取失败");
        return;
    }

  //权限检查(大于等于6.0版本需要动态添加) if(PermissionUtils.checkPermission(mActivity.get(),Manifest.permission.READ_CONTACTS) && PermissionUtils.checkPermission(mActivity.get(),Manifest.permission.READ_EXTERNAL_STORAGE)){ String contactInfoStr=getAllContactInfo(context); if (TextUtils.isEmpty(contactInfoStr)){ promise.reject("获取失败"); }else { promise.resolve(contactInfoStr); } }else {//请求权限(大于等于6.0版本需要动态添加) mPromise=promise; PermissionUtils.requestPermission(mActivity.get(),new String[]{Manifest.permission.READ_CONTACTS, Manifest.permission.READ_EXTERNAL_STORAGE}); }

}
//获取所有通讯录信息
private static String getAllContactInfo (Context context) {
    SystemClock.sleep(3000);
   // ArrayList<HashMap<String, String>> list = new ArrayList<HashMap<String, String>>();
    JSONArray jsonArray=new JSONArray();
    // 1.获取内容解析者
    ContentResolver resolver = context.getContentResolver();
    // 2.获取内容提供者的地址:com.android.contacts
    // raw\_contacts表的地址 :raw\_contacts
    // view\_data表的地址 : data
    // 3.生成查询地址
    Uri raw\_uri = Uri.parse("content://com.android.contacts/raw\_contacts");
    Uri date\_uri = Uri.parse("content://com.android.contacts/data");
    // 4.查询操作,先查询raw\_contacts,查询contact\_id
    // projection : 查询的字段
    Cursor cursor = resolver.query(raw\_uri, new String\[\]{"contact\_id"}, null, null, null);
    try {
        // 5.解析cursor
        if (cursor != null) {
            while (cursor.moveToNext()) {
                // 6.获取查询的数据
                String contact\_id = cursor.getString(0);
                // cursor.getString(cursor.getColumnIndex("contact\_id"));//getColumnIndex
                // : 查询字段在cursor中索引值,一般都是用在查询字段比较多的时候
                // 判断contact\_id是否为空
                if (!TextUtils.isEmpty(contact\_id)) {//null   ""
                    // 7.根据contact\_id查询view\_data表中的数据
                    // selection : 查询条件
                    // selectionArgs :查询条件的参数
                    // sortOrder : 排序
                    // 空指针: 1.null.方法 2.参数为null
                    Cursor c = resolver.query(date\_uri, new String\[\]{"data1",
                                    "mimetype"}, "raw\_contact\_id=?",
                            new String\[\]{contact\_id}, null);
                    //HashMap<String, String> map = new HashMap<String, String>();
                    JSONObject object=new JSONObject();
                    // 8.解析c
                    if (c != null) {
                        while (c.moveToNext()) {
                            // 9.获取数据
                            String data1 = c.getString(0);
                            String mimetype = c.getString(1);
                            // 10.根据类型去判断获取的data1数据并保存
                            if (mimetype.equals("vnd.android.cursor.item/phone\_v2")) {
                                // 电话
                                object.put("phone", data1);
                            } else if (mimetype.equals("vnd.android.cursor.item/name")) {
                                // 姓名
                                object.put("name", data1);
                            }
                        }
                    }
                    // 11.添加到集合中数据
                   // list.add(map);
                    jsonArray.put(object);
                    // 12.关闭cursor
                    if (c != null) {
                        c.close();
                    }
                }
            }
        }
    } catch (JSONException e) {
        e.printStackTrace();
    } finally {
        // 12.关闭cursor
        if (cursor != null) {
            cursor.close();
        }
    }
    return jsonArray.toString();
}
//权限回调
public static void onRequestPermissionsResult(int requestCode, String\[\] permissions, int\[\] grantResults) {
    if (requestCode == PermissionUtils.RC\_REQUEST\_PERMISSIONS) {
        for (int i = 0, j = permissions.length; i < j; i++) {
            if(TextUtils.equals(permissions\[i\],Manifest.permission.READ\_CONTACTS)||
                    TextUtils.equals(permissions\[i\],Manifest.permission.READ\_EXTERNAL\_STORAGE)){
                if (grantResults\[i\] == PackageManager.PERMISSION\_GRANTED) {
                    getContactInfo(mActivity.get(),mPromise);
                }else {
                    if(mActivity==null)return;
                    Toast.makeText(mActivity.get(),"没有使用权限",Toast.LENGTH\_SHORT).show();
                }
            }
        }
    }
}

}

获取手机通讯录,需要添加READ_CONTACTSREAD_EXTERNAL_STORAGE权限。Android6.0版本以下的添加权限在AndroidManifest.xml文件中添加如下:

Android6.0以上版本,部分权限则需动态添加,ContactInfo.java代码示例中有添加。其中涉及到的PermissionUtils.java文件代码如下:

(注:下面只是进行简单的封装,对于权限的管理需自行去查阅)

import android.app.Activity; import android.content.Context; import android.content.pm.PackageManager; import android.support.v4.app.ActivityCompat; import android.support.v4.content.ContextCompat;

public class PermissionUtils { public static final int RC_REQUEST_PERMISSIONS=6006; //检查是否拥有某一权限 public static boolean checkPermission(Context context,String permission){ int result = ContextCompat.checkSelfPermission(context, permission); return result == PackageManager.PERMISSION_GRANTED;

}
//请求获取权限
public static void requestPermission(Activity activity, String\[\] permissions){
    ActivityCompat.requestPermissions(activity,permissions, RC\_REQUEST\_PERMISSIONS);
}

}

2.在MainActivity文件中(具体路径:**android/app/src/main/java/com/your-app-name/MainActivity.java**)添加如下代码:

@Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); ContactInfo.init(this); } @Override public void onRequestPermissionsResult(int requestCode, String[] permissions, int[] grantResults) { super.onRequestPermissionsResult(requestCode, permissions, grantResults); ContactInfo.onRequestPermissionsResult(requestCode,permissions,grantResults); }

备注:红色区域的代码,示例中主要用于权限的添加使用

3.创建ContactInfoModule.java文件,是一个继承了**ReactContextBaseJavaModule**的Java类,实现一些JavaScript所需的功能,代码如下:

import com.facebook.react.bridge.Promise; import com.facebook.react.bridge.ReactApplicationContext; import com.facebook.react.bridge.ReactContextBaseJavaModule; import com.facebook.react.bridge.ReactMethod;

public class ContactInfoModule extends ReactContextBaseJavaModule { public ContactInfoModule(ReactApplicationContext reactContext) { super(reactContext); }

@Override
public String getName() {
    return "ContactInfo";
}

@ReactMethod
public void getAllContactInfo(Promise promise){
    ContactInfo.getContactInfo(getReactApplicationContext(),promise);
}

}

**ReactContextBaseJavaModule要求派生类实现getName**方法。这个函数用于返回一个字符串名字,这个名字在JavaScript端标记这个模块。

要导出一个方法给JavaScript使用,Java方法需要使用注解**@ReactMethod。方法的返回类型必须为void**。

下面的参数类型在**@ReactMethod**注明的方法中,会被直接映射到它们对应的JavaScript类型。

Boolean -> Bool
Integer -> Number
Double -> Number
Float -> Number
String -> String
Callback -> function
ReadableMap -> Object
ReadableArray -> Array

React Native的跨语言访问是异步进行的,所以想要给JavaScript返回一个值的唯一办法是使用回调函数或者发送事件。(示例代码中使用的是Promises,参见下面更多的描述)

注册与导出React Native原生模块

1.创建ContactInfoReactPackage.java文件,为了向React Native注册我们刚才创建的原生模块,我们需要实现**ReactPackageReactPackage**主要为注册原生模块所存在,只有已经向React Native注册的模块才能在js模块使用。

public class ContactInfoReactPackage implements ReactPackage { @Override public List createNativeModules(ReactApplicationContext reactContext) { List modules = new ArrayList<>();

    modules.add(new ContactInfoModule(reactContext));
    return modules;
}

@Override
public List<Class<? extends JavaScriptModule>> createJSModules() {
    return Collections.emptyList();
}

@Override
public List<ViewManager> createViewManagers(ReactApplicationContext reactContext) {
    return Collections.emptyList();
}

}

2.接下来呢,我们还需要在android/app/src/main/java/com/your-app-name/MainApplication.java中注册我们的ContactInfoReactPackage

@Override protected List getPackages() { return Arrays.asList( new MainReactPackage(), new ContactInfoReactPackage() ); }

3.为了让你的功能从JavaScript端访问起来更为方便,通常我们都会把原生模块封装成一个JavaScript模块。这不是必须的,但省下了每次都从**NativeModules中获取对应模块的步骤。这个JS文件也可以用于添加一些其他JavaScript端实现的功能.创建Contacts.js**文件,代码如下:

import { NativeModules } from 'react-native'; export default NativeModules.ContactInfo;

现在,在别处的JavaScript代码中可以这样调用你的方法:

import Contacts from './Contacts'; ......省略代码 Contacts.getAllContactInfo().then(result => { this.setState({ result: result }) }).catch(e => { this.setState({ result: e }) });

更多

Callbacks

原生模块还支持一种特殊的参数——回调函数。它提供了一个函数来把返回值传回给JavaScript。

public class UIManagerModule extends ReactContextBaseJavaModule {

...

  @ReactMethod
  public void measureLayout(
      int tag,
      int ancestorTag,
      Callback errorCallback,
      Callback successCallback) {
    try {
      measureLayout(tag, ancestorTag, mMeasureBuffer);
      float relativeX = PixelUtil.toDIPFromPixel(mMeasureBuffer[0]);
      float relativeY = PixelUtil.toDIPFromPixel(mMeasureBuffer[1]);
      float width = PixelUtil.toDIPFromPixel(mMeasureBuffer[2]);
      float height = PixelUtil.toDIPFromPixel(mMeasureBuffer[3]);
      successCallback.invoke(relativeX, relativeY, width, height);
    } catch (IllegalViewOperationException e) {
      errorCallback.invoke(e.getMessage());
    }
  }

...

这个函数可以在JavaScript里这样使用:

UIManager.measureLayout(
  100,
  100,
  (msg) => {
    console.log(msg);
  },
  (x, y, width, height) => {
    console.log(x + ':' + y + ':' + width + ':' + height);
  }
);

原生模块通常只应调用回调函数一次。但是,它可以保存callback并在将来调用。

请务必注意callback并非在对应的原生函数返回后立即被执行——注意跨语言通讯是异步的,这个执行过程会通过消息循环来进行。

Promises

原生模块还可以使用promise来简化代码,搭配ES2016(ES7)标准的async/await语法则效果更佳。如果桥接原生方法的最后一个参数是一个Promise,则对应的JS方法就会返回一个Promise对象。

我们把上面的代码用promise来代替回调进行重构:

import com.facebook.react.bridge.Promise;

public class UIManagerModule extends ReactContextBaseJavaModule {

...

  @ReactMethod
  public void measureLayout(
      int tag,
      int ancestorTag,
      Promise promise) {
    try {
      measureLayout(tag, ancestorTag, mMeasureBuffer);

      WritableMap map = Arguments.createMap();

      map.putDouble("relativeX", PixelUtil.toDIPFromPixel(mMeasureBuffer[0]));
      map.putDouble("relativeY", PixelUtil.toDIPFromPixel(mMeasureBuffer[1]));
      map.putDouble("width", PixelUtil.toDIPFromPixel(mMeasureBuffer[2]));
      map.putDouble("height", PixelUtil.toDIPFromPixel(mMeasureBuffer[3]));

      promise.resolve(map);
    } catch (IllegalViewOperationException e) {
      promise.reject(e.getMessage());
    }
  }

...

现在JavaScript端的方法会返回一个Promise。这样你就可以在一个声明了async的异步函数内使用await关键字来调用,并等待其结果返回。(虽然这样写着看起来像同步操作,但实际仍然是异步的,并不会阻塞执行来等待)。

async function measureLayout() {
  try {
    var {
      relativeX,
      relativeY,
      width,
      height,
    } = await UIManager.measureLayout(100, 100);

    console.log(relativeX + ':' + relativeY + ':' + width + ':' + height);
  } catch (e) {
    console.error(e);
  }
}

measureLayout();

发送事件到JavaScript

原生模块可以在没有被调用的情况下往JavaScript发送事件通知,最简单的办法就是通过RCTDeviceEventEmitter,这可以通过ReactContext来获得对应的引用,像这样:

...
private void sendEvent(ReactContext reactContext,
                       String eventName,
                       @Nullable WritableMap params) {
  reactContext
      .getJSModule(DeviceEventManagerModule.RCTDeviceEventEmitter.class)
      .emit(eventName, params);
}
...
WritableMap params = Arguments.createMap();
...
sendEvent(reactContext, "keyboardWillShow", params);

JavaScript模块可以通过使用DeviceEventEmitter模块来监听事件:

import { DeviceEventEmitter } from 'react-native';
...
componentWillMount: function() {
  DeviceEventEmitter.addListener('keyboardWillShow', function(e: Event) {
    // handle event.
  });
}
...
点赞
收藏
评论区
推荐文章
blmius blmius
2年前
MySQL:[Err] 1292 - Incorrect datetime value: ‘0000-00-00 00:00:00‘ for column ‘CREATE_TIME‘ at row 1
文章目录问题用navicat导入数据时,报错:原因这是因为当前的MySQL不支持datetime为0的情况。解决修改sql\mode:sql\mode:SQLMode定义了MySQL应支持的SQL语法、数据校验等,这样可以更容易地在不同的环境中使用MySQL。全局s
Jacquelyn38 Jacquelyn38
2年前
2020年前端实用代码段,为你的工作保驾护航
有空的时候,自己总结了几个代码段,在开发中也经常使用,谢谢。1、使用解构获取json数据let jsonData  id: 1,status: "OK",data: 'a', 'b';let  id, status, data: number   jsonData;console.log(id, status, number )
皕杰报表之UUID
​在我们用皕杰报表工具设计填报报表时,如何在新增行里自动增加id呢?能新增整数排序id吗?目前可以在新增行里自动增加id,但只能用uuid函数增加UUID编码,不能新增整数排序id。uuid函数说明:获取一个UUID,可以在填报表中用来创建数据ID语法:uuid()或uuid(sep)参数说明:sep布尔值,生成的uuid中是否包含分隔符'',缺省为
Stella981 Stella981
2年前
Android So动态加载 优雅实现与原理分析
背景:漫品Android客户端集成适配转换功能(基于目标识别(So库35M)和人脸识别库(5M)),导致apk体积50M左右,为优化客户端体验,决定实现So文件动态加载.!(https://oscimg.oschina.net/oscnet/00d1ff90e4b34869664fef59e3ec3fdd20b.png)点击上方“蓝字”关注我
Stella981 Stella981
2年前
Python之time模块的时间戳、时间字符串格式化与转换
Python处理时间和时间戳的内置模块就有time,和datetime两个,本文先说time模块。关于时间戳的几个概念时间戳,根据1970年1月1日00:00:00开始按秒计算的偏移量。时间元组(struct_time),包含9个元素。 time.struct_time(tm_y
Wesley13 Wesley13
2年前
00:Java简单了解
浅谈Java之概述Java是SUN(StanfordUniversityNetwork),斯坦福大学网络公司)1995年推出的一门高级编程语言。Java是一种面向Internet的编程语言。随着Java技术在web方面的不断成熟,已经成为Web应用程序的首选开发语言。Java是简单易学,完全面向对象,安全可靠,与平台无关的编程语言。
Wesley13 Wesley13
2年前
Unity横屏
Android下发现Unity里面的Player设置,并不能完全有效,比如打开了自动旋转,启动的时候还是会横屏,修改XML添加以下代码<applicationandroid:icon"@drawable/ic\_launcher"                    android:label"@string/app\_name"
Stella981 Stella981
2年前
Django中Admin中的一些参数配置
设置在列表中显示的字段,id为django模型默认的主键list_display('id','name','sex','profession','email','qq','phone','status','create_time')设置在列表可编辑字段list_editable
Wesley13 Wesley13
2年前
MySQL部分从库上面因为大量的临时表tmp_table造成慢查询
背景描述Time:20190124T00:08:14.70572408:00User@Host:@Id:Schema:sentrymetaLast_errno:0Killed:0Query_time:0.315758Lock_
Python进阶者 Python进阶者
3个月前
Excel中这日期老是出来00:00:00,怎么用Pandas把这个去除
大家好,我是皮皮。一、前言前几天在Python白银交流群【上海新年人】问了一个Pandas数据筛选的问题。问题如下:这日期老是出来00:00:00,怎么把这个去除。二、实现过程后来【论草莓如何成为冻干莓】给了一个思路和代码如下:pd.toexcel之前把这