qxml

English

一个低侵入，可配置的 Android 库，用于将 layout xml 文件转换为 Java 代码以提高性能。

与X2C的对比

X2C：

• 使用注解处理器生成View类，使用时需要在类中添加注解，并替换setContentView方法，侵入性较强；
• 对于布局属性的支持不够完美，在生成的类中容易报错；
• 自定义属性的拓展不够方便；
• 对多layout type、View Compat、LayoutInflate Factory等等的支持不够全面。

Qxml：

• 使用transform生成View类，生成View的规则通过添加注解类实现，可以做到规则与代码的边界分离，无需改动原有代码即可接入；
• 对布局属性支持较好，目标是完全的UI一致性（详见 demo UI测试）；
• 自定义属性可实现复杂的逻辑，拓展方便实现；
• 支持多layout type、View Compat、LayoutInflate Factory等等特性，可实现换肤，拓展View等功能。

性能表现

与 inflate 比较可减少 40%+加载时间，随布局复杂度提高而提高，详见 demo 性能测试。

support-test-demo.apk

androidx-test-demo.apk

要求

AGP 3.5.0 以上 Gradle 5.6.4 以上

目前支持的组件

Base

组件	支持属性	组件	支持属性	组件	支持属性
View	almost	TextView	almost	EditText	almost
Button	almost	ImageView	almost	Button	almost
CheckBox	almost	ImageButton	almost	ImageView	almost
SeekBar	almost	RatingBar	almost	Spinner	almost
Switch	almost	tableLayout	almost	TableRow	almost
ViewStub	almost	ScrollView	almost	HorizontalScrollView	almost
ProgressBar	almost	SurfaceView	almost	RadioGroup	almost
RadioButton	almost	LinearLayout	almost	RelativeLayout	almost
FrameLayout	almost	TextureView	almost	WebView	almost
ListView	almost	GridLayout	almost	ExpandableListView	almost
ViewFlipper	almost	ViewSwitcher	almost	TextSwitcher	almost
VideoView	almost	ToggleButton	almost	Space	almost
include	almost	merge	almost	DataBinding	almost
custom style	almost	system style	none	layout multi type	almost

Support & Androidx

组件	支持属性	组件	支持属性	组件	支持属性
AppBarLayout	almost	CardView	almost	CollapsingToolbarLayout	almost
ConstraintLayout	almost	Group	almost	Guideline	almost
Placeholder	almost	Barrier	almost	MotionLayout	almost
CoordinatorLayout	almost	DrawerLayout	almost	RecyclerView	almost
NestedScrollView	almost	TabLayout	almost	TabItem	almost
Toolbar	almost	ViewPager	all	Fragment	androidx not support
SwipeRefreshLayout	all	TextInputLayout	almost

Third Part

组件	支持属性	组件	支持属性	组件	支持属性
Lottie	almost	fresco	almost

基础使用

1. 在 Project build.gradle 中添加依赖

buildscript {
    ...
    ext.qxml_version = "3.4.0"
    repositories {
        ...
        mavenCentral()
    }
    ...
    dependencies {
        ...
        classpath "io.github.duduhuang88:gradle-plugin:$qxml_version"
        ...
    }
}

2. 在 module build.gradle 中添加依赖

// 于 apply plugin: 'com.android.application' or 'com.android.library' 之后
apply plugin: 'com.qxml.code.plugin'

compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
}

dependencies {
    ...

	kapt "io.github.duduhuang88:qxml-processor:$qxml_version"
		or
	annotationProcessor "io.github.duduhuang88:qxml-processor:$qxml_version"

	//support
	implementation "io.github.duduhuang88:qxml-support:$qxml_version"

	//androidx
	implementation "io.github.duduhuang88:qxml-androidx:$qxml_version"
	...
}

3. 配置

android {
    ......
    sourceSets {
        main {
            ......
            resources.srcDirs += "build/qxml/tempRes"
            ......
        }
    }
}

qxml {
    enable true		 //是否开启，默认true
    useFactory false		 //是否使用layoutInflater的factory，开启时性能有损耗，默认false
    viewDebug false		 //是否在转换的View上显示标志，默认false
    logEnable false		 //是否开启log，默认false
    debugEnable false	 //是否开启debug，默认false，开启时会输出一些调试信息和文件
    compatMode com.qxml.CompatMode.AUTO  //compat模式，默认AUTO
    acceptReferenceStyle true     //是否接受style引用，仅支持很少部分引用，默认true
    ignoreUnImplementAttr true //是否忽略未实现的属性，默认true
    useCreateViewListener true   //使用createViewListener，默认false
    checkMethod false                //是否检查View属性配置变化进行重新生成，设置false可提高transform速度，默认false，如果修改/自定义View属性时设置为false需删除缓存（build/qxml或clean）
    
    //3.4.0起支持移除已转换layout文件
    //在root build.gradle同级目录中可创建qxmlRemoveLayoutWhiteList.txt白名单文件，内容格式为layout文件名，按行读取，eg：
    /*
        activity_main
        imageview_test
    */
    //开启后会自动保留转换失败的layout所关联的layout文件，但未经qxml处理的layout文件需在白名单文件中声明，如动态创建的ViewStub#setLayoutResource引用的layout文件
    removeConvertedLayout false    

    //以上为默认设置
    /*buildType {
        debug { //单独配置debug，没有设置的值会使用默认设置
            viewDebug false
        }
        release {
            viewDebug false
        }
    }*/
}

4. gradle.properties可选配置

QXML_VALID_CODE = *** : 自定义View时使用，用于本地验签

QXML_LOG_ENABLE = true/false : 是否开启annotationProcesser的log

QXML_USING_STABLE_ID = true/false : 是否使用固定资源Id 已废弃

5. layout可选配置

在layout.xml根节点中可使用：

app:qxml : genIgnore(忽略) genWithUnImplementAttr(生成) genWithoutUnImplementAttr(当没有未实现的属性时才生成)

app:qxml_use_factory： 使用 Layoutinflater factory

app:qxml_debug：是否显示view的debug标志

app:qxml_compat：never(不使用compat) auto(自动选择) force(强制使用)

注：配置对根节点下的全部View都生效，且优先级高于gradle中的配置

6. 简单的构建结果的图表显示

构建结束后，在 build\qxml\report.html 中有简单的结果图表，生成的View代码在 build\qxml\genClassInfo* 中

7. 混淆

暂无需要

扩展使用

缺点

1. 不支持 Android 内置 style

2. 增加编译时间，首次编译根据 layout 数量和复杂度增长，而后会使用缓存

3. 增加 apk 体积，在 demo 中 52 个 layout 文件时，release apk 体积增加了约 38K，后续可能会添加重打包移除已转换 layout 文件的选项，3.4.0已实装，开启后请进行充分测试，将动态引用的layout文件加入白名单

4. 目前扩展 View 需使用全限定类名，后续可能会改善这种情况，除定义共享变量外已无需全限定类名

LICENSE

Copyright 2021 duduhuang88

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.