# Integrate to Android App

TIP

Currently, Weex supports the following ABIs:

  • x86
  • armeabi-v7a
  • arm64-v8a

The following documents assume that you already have a certain Android development experience.

# 1. Configure dependency

TIP

Since 0.28.0, Weex would publish two convenience binary in each release, please read the documentation about the detail.

dependencies {
    ...
    // Choose one of the following sdk of weex.
    //compile 'org.apache.weex:sdk:0.28.0'
    //compile 'org.apache.weex:sdk_legacy:0.28.0'

    // fastjson
    compile 'com.alibaba:fastjson:1.1.46.android'

    //support library dependencies
    compile 'com.android.support:recyclerview-v7:23.1.1'
    compile 'com.android.support:support-v4:23.1.1'
    compile 'com.android.support:appcompat-v7:23.1.1'
}

# 2. Configure proguard

proguard rules are as follows,recommended reference to the latest source configuration

-keep class com.taobao.weex.bridge.** { *; }
-keep class com.taobao.weex.layout.** { *; }
-keep class com.taobao.weex.WXSDKEngine { *; }
-keep class com.taobao.weex.base.SystemMessageHandler { *; }
-dontwarn com.taobao.weex.bridge.**

# 3. Add permissions

Add required permissions in your AndroidManifest.xml

<uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>

# 4. Init Weex SDK

Init Weex SDK When Application Create

InitConfig config = new InitConfig.Builder()
					//imageLib interface 
    				.setImgAdapter(new FrescoImageAdapter())
    				//network lib interface
    				.setHttpAdapter(new InterceptWXHttpAdapter())
    				.build();
WXSDKEngine.initialize(applicationContext,config);

# 5. Create an WXSDKInstance

  • create an WXSDKInstance add IWXRenderListener and activity lifecycle on it.
  • load weex bundle url. when page load success;
  • target view will be send for you on onViewCreated callback, set target view to activity contentView.
public class MainActivity extends AppCompatActivity implements IWXRenderListener {
  WXSDKInstance mWXSDKInstance;
  @Override
  protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);
    mWXSDKInstance = new WXSDKInstance(this);
    mWXSDKInstance.registerRenderListener(this);
    /**
    * bundleUrl source http://dotwe.org/vue/38e202c16bdfefbdb88a8754f975454c
    */
    String pageName = "WXSample";
    String bundleUrl = "http://dotwe.org/raw/dist/38e202c16bdfefbdb88a8754f975454c.bundle.wx";
    mWXSDKInstance.renderByUrl(pageName, bundleUrl, null, null,WXRenderStrategy.APPEND_ASYNC);
  }
  @Override
  public void onViewCreated(WXSDKInstance instance, View view) {
    setContentView(view);
  }
  @Override
  public void onRenderSuccess(WXSDKInstance instance, int width, int height) {
  }
  @Override
  public void onRefreshSuccess(WXSDKInstance instance, int width, int height) {
  }
  @Override
  public void onException(WXSDKInstance instance, String errCode, String msg) {
  }
  @Override
  protected void onResume() {
    super.onResume();
    if(mWXSDKInstance!=null){
      mWXSDKInstance.onActivityResume();
    }
  }
  @Override
  protected void onPause() {
    super.onPause();
    if(mWXSDKInstance!=null){
       mWXSDKInstance.onActivityPause();
    }
  }
  @Override
  protected void onStop() {
    super.onStop();
    if(mWXSDKInstance!=null){
      mWXSDKInstance.onActivityStop();
    }
  }
  @Override
  protected void onDestroy() {
    super.onDestroy();
    if(mWXSDKInstance!=null){
      mWXSDKInstance.onActivityDestroy();
    }
  }
}

# 6. Run

Run app ,start activity, then you will see hello world demo. well done.

Hello World Demo Source

Tip: Click QRCode Image in Demo Source Page, your will see compiled bundle js.

# 7. Extend-Android

Weex supports module-extend、component-extend and adapter-extend

Extend Android Doc

Last Updated: 10/25/2019
Excellent docUnusable doc