XPage

Project Url: xuexiangjys/XPage
Introduction: 一个非常方便的 fragment 页面框架
More: Author   ReportBugs   
Tags:
page-

I Star

一个非常方便的 Fragment 页面框架！还不赶紧点击使用说明文档，体验一下吧！

另外，你还可以参见XPage 视频教程进行学习。

关于我

公众号 掘金 知乎 CSDN 简书 思否 哔哩哔哩 今日头条
我的 Android 开源之旅 点我 点我 点我 点我 点我 点我 点我

X 系列库快速集成

为了方便大家快速集成 X 系列框架库，我提供了一个空壳模版供大家参考使用: https://github.com/xuexiangjys/TemplateAppProject

除此之外，我还特别制作了几期X 系列视频教程供大家学习参考.

特征

  • 支持 assets 下“corepage.json”静态配置 Fragment 页面信息。
  • 支持 Application 中动态配置 Fragment 页面信息。
  • 支持通过注解@Page 的方式动态自动配置页面信息。
  • 支持自定义 Fragment 页面信息配置。
  • 支持 4 种默认 Fragment 页面切换动画。
  • 支持 Fragment 页面间参数传递。
  • 支持 Fragment 页面属性保存。
  • 支持 Fragment 页面的 onKeyDown、onFragmentResult 等生命周期
  • 支持 Fragment 和 Fragment 页面自由跳转以及数据交互。
  • 支持导航栏通过注解的方式自动添加及设置。
  • 支持自定义 TitleBar 全局主题属性。
  • 支持自定义 Fragment 页面容器。
  • 支持自定义 Activity 页面容器。
  • 支持 Fragment 之间、activity 和 fragment 之间的数据交互。
  • 兼容 kotlin 和 androidx。

Star 趋势图

Stargazers over time

1、演示（请 star 支持）

xpage.gif

Demo 下载

downloads

2、如何使用

目前支持主流开发工具 AndroidStudio 的使用，直接配置 build.gradle，增加依赖即可.

2.1、Android Studio 导入方法，添加 Gradle 依赖

1.先在项目根目录的 build.gradle 的 repositories 添加:

allprojects {
     repositories {
        ...
        maven { url "https://jitpack.io" }
    }
}

2.然后在应用项目(一般是 app)的 build.gradle 的 dependencies 添加:

以下是版本说明，选择一个即可。

  • androidx 版本：3.0.0 及以上
dependencies {
  ...
  // XPage
  implementation 'com.github.xuexiangjys.XPage:xpage-lib:3.4.0'
  annotationProcessor 'com.github.xuexiangjys.XPage:xpage-compiler:3.4.0'
}

【版本注意】3.3.0 及以上版本去除了 ButterKnife 的依赖。

【升级注意】从 3.3.0 以下 升级到 3.4.0 及以上：

    @Deprecated
    protected abstract View inflateView(LayoutInflater inflater, ViewGroup container);

------> 替换为

    protected abstract View onCreateContentView(@NonNull LayoutInflater inflater, @Nullable ViewGroup container, boolean attachToRoot);
  • support 版本：2.3.0 及以下
dependencies {
  ...
  // XPage
  implementation 'com.github.xuexiangjys.XPage:xpage-lib:2.3.0'
  annotationProcessor 'com.github.xuexiangjys.XPage:xpage-compiler:2.3.0'
  // ButterKnife 的 sdk
  implementation 'com.jakewharton:butterknife:8.4.0'
  annotationProcessor 'com.jakewharton:butterknife-compiler:8.4.0'
}

【注意】如果你使用的是 kotlin，请使用如下配置:

apply plugin: 'kotlin-kapt'

dependencies {
  ...
  //XPage
  implementation 'com.github.xuexiangjys.XPage:xpage-lib:3.4.0'
  kapt 'com.github.xuexiangjys.XPage:xpage-compiler:3.4.0'
}

【注意】：如果你使用的 module 不止一个的话，每个 module 下都需要增加 XPage 的依赖。

3.进行 moduleName 注册

defaultConfig {
    ...

    javaCompileOptions {
        annotationProcessorOptions {
            arguments = [ moduleName : project.getName() ]
        }
    }
}

【注意】：如果不注册的话，默认 ModuleName 为app。

2.2、页面注册

2.2.1、assets 中静态注册

在 assets 文件夹中新建“corepage.json“，然后进行如下配置：

[
  {
    "name": "测试页面 1",
    "classPath": "com.xuexiang.xpagedemo.fragment.TestFragment1",
    "params": ""
  },
  {
    "name": "测试页面 2",
    "classPath": "com.xuexiang.xpagedemo.fragment.TestFragment2",
    "params": {
      "key1":"这是参数 1 的值",
      "key2":"这是参数 2 的值"
    }
  }，
]

2.2.2、Application 中动态注册【推荐】

1.自动进行页面注册【推荐】

使用 apt 编译时自动生成的页面注册配置类 "moduleName"+PageConfig 的 getPages()进行注册。

PageConfig.getInstance()
//      //页面注册,默认不设置的话使用的就是自动注册
//      .setPageConfiguration(new AutoPageConfiguration())
        .debug("PageLog")       //开启调试
        .setContainActivityClazz(XPageActivity.class) //设置默认的容器 Activity
        .init(this);            //初始化页面配置

【注意】：如果你的项目中只是增加了依赖，还没有使用@Page 注解 XPageFragment 页面的话，在编译时是不会自动生成注册页面的！！

2.手动动态进行页面注册

PageConfig.getInstance()
        .setPageConfiguration(new PageConfiguration() { //页面注册
            @Override
            public List<PageInfo> registerPages(Context context) {
                List<PageInfo> pageInfos = new ArrayList<>();
                addPageInfoAndSubPages(pageInfos, MainFragment.class);
                pageInfos.add(PageConfig.getPageInfo(DateReceiveFragment.class));
                return pageInfos;        //手动注册页面
            }
        })
        .debug("PageLog")       //开启调试
        .init(this);            //初始化页面配置

2.3、使用 PageOption 进行页面操作【推荐】

使用PageOption.to进行页面选项构建。

PageOption.to(TestFragment.class) //跳转的 fragment
    .setAnim(CoreAnim.zoom) //页面跳转动画
    .setRequestCode(100) //请求码，用于返回结果
    .setAddToBackStack(true) //是否加入堆栈
    .setNewActivity(true, ContainActivity.class) //是否使用新的 Activity 打开
    .putBoolean(DateReceiveFragment.KEY_IS_NEED_BACK, true) //传递的参数
    .open(this); //打开页面进行跳转

2.4、页面跳转

使用 XPage，Activity 必须要继承XPageActivity,Fragment 必须要继承XPageFragment，否则将无法调用页面跳转的openPage方法。

2.4.1、携带数据

Bundle params = new Bundle();
switch(position) {
    case 0:
        params.putBoolean(DateReceiveFragment.KEY_IS_NEED_BACK, false);
        int id = (int) (Math.random() * 100);
        params.putString(DateReceiveFragment.KEY_EVENT_NAME, "事件" + id);
        params.putString(DateReceiveFragment.KEY_EVENT_DATA, "事件" + id + "携带的数据");
        openPage(DateReceiveFragment.class, params);
        break;
    case 1:
        params.putBoolean(DateReceiveFragment.KEY_IS_NEED_BACK, true);
        openPageForResult(DateReceiveFragment.class, params, 100);
        break;
    default:
        break;
}

2.4.2、页面切换动画

switch(position) {
    case 0:
        openPage(TestFragment.PAGE_NAME, null, CoreAnim.none);//没有动画
        break;
    case 1:
        openPage(TestFragment.PAGE_NAME, null, CoreAnim.present);//由下到上动画
        break;
    case 2:
        openPage(TestFragment.PAGE_NAME, null, CoreAnim.slide);//从左到右动画
        break;
    case 3:
        openPage(TestFragment.PAGE_NAME, null, CoreAnim.fade);//渐变
        break;
    case 4:
        openPage(TestFragment.PAGE_NAME, null, CoreAnim.zoom);//放大
        break;
    default:
        break;
}

2.5、TitleBar 样式自定义

可以设置XPageTitleBarStyle主题样式来自定义标题栏的默认样式。

<!-- Base application theme. -->
<style name="AppTheme" parent="Theme.AppCompat.Light.NoActionBar">
    <!-- Customize your theme here. -->
    <item name="colorPrimary">@color/xpage_default_actionbar_color</item>
    <item name="colorPrimaryDark">@color/xpage_default_actionbar_color</item>
    <item name="colorAccent">@color/xpage_default_actionbar_color</item>

    <!--标题栏的背景图片，优先使用背景图片，没有背景图片才使用背景颜色，可选-->
    <item name="xpage_actionbar_background">@null</item>
    <!--标题栏的背景颜色-->
    <item name="xpage_actionbar_color">@color/xpage_default_actionbar_color</item>
    <!--是否支持沉浸式标题栏, 默认 false-->
    <item name="xpage_actionbar_immersive">false</item>
    <!--标题栏返回箭头, 默认 R.drawable.xpage_ic_navigation_back_white-->
    <item name="xpage_actionbar_navigation_back">@drawable/xpage_ic_navigation_back_white</item>
    <!--标题栏的高度，默认 52dp-->
    <item name="xpage_actionbar_height">60dp</item>
    <!--标题栏标题文字的大小，默认 18sp-->
    <item name="xpage_actionbar_title_text_size">21sp</item>
    <!--标题栏副标题文字的大小，默认 12sp-->
    <item name="xpage_actionbar_sub_text_size">14sp</item>
    <!--标题栏动作文字的大小，默认 15sp-->
    <item name="xpage_actionbar_action_text_size">18sp</item>
    <!--标题栏动作图片的 padding，默认 5dp-->
    <item name="xpage_actionbar_action_padding">6dp</item>
    <!--标题栏两侧文字的 padding，默认 14dp-->
    <item name="xpage_actionbar_side_text_padding">16dp</item>

    <item name="XPageTitleBarStyle">@style/XPageTitleBar.Custom</item>
</style>

<style name="XPageTitleBar.Custom">
    <item name="tb_immersive">false</item>
    <item name="tb_centerGravity">center</item>
</style>

2.6、利用 XPage 来写程序的 Tab 主页

详细可参见BottomNavigationViewFragment

就像正常使用 ViewPager 加载 Fragment 那样。但是这里需要注意的两点是：

  • 由于使用 ViewPager 进行加载，而非 XPage,因此 Fragment 的 initTitleBar 方法需要被覆盖。
@Override
protected TitleBar initTitleBar() {
    //不使用@Page 标注的一定要注意覆盖这个方法
    return null;
}
  • 由于为了新开页面不影响 Tab 主页当前容器的状态，需要在打开新页面的使用设置使用新容器。
PageOption.to(TestFragment.class)
        //新建一个容器，以不影响当前容器
        .setNewActivity(true)
        .open(this);

2.7、复杂 Activity 界面容器的自定义

详细可参见ComplexActivity

1.自定义页面容器的布局，在布局中一定要包含 idfragment_container。

<FrameLayout
    android:id="@id/fragment_container"
    android:layout_width="match_parent"
    android:layout_height="400dp">
</FrameLayout>

2.在 XPageActivity 中设置页面容器的自定义布局

@Override
protected View getCustomRootView() {
    binding = ActivityComplexBinding.inflate(getLayoutInflater());
    return binding.getRoot();
}

3.使用changePage方法切换 Fragment。

changePage(TestFragment.PAGE_NAME, null, CoreAnim.none);

【注意】在切换 Fragment 的时候，fragment 并不会走 onResume 和 onPause 生命周期，建议使用 onHiddenChanged 代替。

4.使用getPage方法获取指定的 Fragment，就可以获取该 fragment 页面中的数据。

TabAFragment tabAFragment = getPage(TabAFragment.class);
if (tabAFragment != null) {
    ToastUtils.toast(tabAFragment.getData());
} else {
    ToastUtils.toast("页面还未加载！");
}

混淆配置

  • 3.2.0 及以上版本，使用的是 gson 进行序列化的，所以配置如下：
# gson
-keepattributes Signature
-keepattributes *Annotation*
-dontwarn sun.misc.**
-keep class com.google.gson.examples.android.model.** { <fields>; }
-keep class * extends com.google.gson.TypeAdapter
-keep class * implements com.google.gson.TypeAdapterFactory
-keep class * implements com.google.gson.JsonSerializer
-keep class * implements com.google.gson.JsonDeserializer
-keepclassmembers,allowobfuscation class * {
  @com.google.gson.annotations.SerializedName <fields>;
}
-keep,allowobfuscation,allowshrinking class com.google.gson.reflect.TypeToken
-keep,allowobfuscation,allowshrinking class * extends com.google.gson.reflect.TypeToken

# xpage
-keep class com.xuexiang.xpage.annotation.** { *; }
-keep class com.xuexiang.xpage.config.** { *; }
  • 3.1.1 及以下版本，使用的是 fastjson 进行序列化的，所以配置如下：
# fastjson
-dontwarn com.alibaba.fastjson.**
-keep class com.alibaba.fastjson.** { *; }
-keepattributes Signature

# xpage
-keep class com.xuexiang.xpage.annotation.** { *; }
-keep class com.xuexiang.xpage.config.** { *; }

特别感谢

https://github.com/lizhangqu/CorePage/

如果觉得项目还不错，可以考虑打赏一波

你的打赏是我维护的动力，我将会列出所有打赏人员的清单在下方作为凭证，打赏前请留下打赏项目的备注！

pay.png

联系方式

Highly Recommended：Google Play 4.7 Star Android Developer Tools, Decompile, View Manifest, Open Debug Options Quickly

Apps
Android Developer Tools
Android Developer Tools Pro
About Me
Tools: TimeShining
GitHub: Trinea
Facebook: Dev Tools