MaterialNavigationDrawer入门实战:init()方法3步配置Section、Bottom Section与抽屉头部
MaterialNavigationDrawer入门实战:init()方法3步配置Section、Bottom Section与抽屉头部
MaterialNavigationDrawer 是一个 Material Design 风格的 Android 导航抽屉(Navigation Drawer)库,只需在 init() 方法里完成 3 步配置——添加 Section 列表、Bottom Section 底部项和抽屉头部账号——就能做出 Google 官方 App 同款的侧边栏体验。它要求 API 10+,依赖 support v7 的 Toolbar。
一、先认识这个项目:一个抽象 Activity 搞定侧边栏
MaterialNavigationDrawer 库的核心是一个抽象类 MaterialNavigationDrawer.java,它继承 AppCompatActivity,内部已经封装好了:
- 抽屉滑动、选中态高亮、Toolbar 颜色联动
- Fragment / Activity / 回调 3 种 Section 跳转目标
- 多账号切换的头像动画、旋转屏幕状态恢复
- 平板横屏多栏模式(MultiPane)
你唯一要做的,就是继承它,并在 onCreate 框架自动回调的 init() 方法里完成配置。模块源码位于 MaterialNavigationDrawerModule/,示例 App 位于 MaterialNavigationDrawer/app/,依赖通过 build.gradle 以 compile project(':MaterialNavigationDrawerModule') 方式引入。
二、核心流程:init() 方法里的 3 步配置
整个配置流程一句话概括:继承 Activity → 配置头部 → addSection() → addBottomSection()。下面逐步拆解。
第 1 步:继承 MaterialNavigationDrawer,实现 init()
init() 是唯一的抽象方法(见 源码定义),所有抽屉配置都必须写在里面:
public class HomeActivity extends MaterialNavigationDrawer<Fragment> {
@Override
public void init(Bundle savedInstanceState) {
// 头部、Section、Bottom Section 全部在这里配置
}
}
⚠️ 注意:这个库有自己专属的内容布局,不要调用
setContentView(),页面内容全部放在 Section 对应的 Fragment 里(强行调用会抛出RuntimeException,见 源码)。
第 2 步:addSection() 添加主导航 Section
newSection() 根据第 3 个参数的类型,决定点击后的行为:
| 目标类型 | newSection 参数组合 | 点击行为 |
|---|---|---|
| Fragment | newSection(标题, 图标, Fragment) |
切换到该 Fragment 页面 |
| Activity | newSection(标题, 图标, Intent) |
启动新的 Activity |
| 回调监听 | newSection(标题, 图标, MaterialSectionListener) |
执行自定义逻辑 |
参照示例 Test.java 中的写法:
this.addSection(newSection("Section 1", new TestFragment()));
this.addSection(newSection("Section 3", R.drawable.ic_mic_white_24dp, new TestFragment()))
.setSectionColor(Color.parseColor("#9c27b0"));
其中 addSection() 会把 Section 以 48dp 高度加入抽屉列表,选中项自动高亮;setSectionColor() 可为单个 Section 指定专属主题色(见 MaterialSection.java)。
第 3 步:addBottomSection() 添加底部固定项
Bottom Section 与普通 Section 用法完全相同,只是调用 addBottomSection(),它会自动吸附在抽屉底部(列表过长放不下时会移到列表下方),中间用分隔线隔开。适合放"Settings""About"这类低频入口:
// 来自示例 Accounts.java
this.addBottomSection(newSection("Settings", R.drawable.ic_settings_black_24dp,
new Intent(this, Settings.class)));
完整示例可直接参考 Accounts.java:头部账号 + 4 个 Section + 1 个底部项,共约 20 行代码。
三、抽屉头部 4 种样式配置
抽屉头部类型由主题属性 drawerType 决定(取值定义在 integers.xml),在 styles.xml 中配置:
| 类型值 | 头部样式 | 配套代码 |
|---|---|---|
DRAWERTYPE_ACCOUNTS(0,默认) |
账号头像头部:大头像 + 昵称 + 邮箱 + 账号切换 | addAccount() |
DRAWERTYPE_IMAGE(1) |
纯图片头部 | setDrawerHeaderImage() |
DRAWERTYPE_CUSTOM(2) |
任意自定义 View 头部 | setDrawerHeaderCustom(view) |
DRAWERTYPE_NO_HEADER(3) |
无头部,Section 直接置顶 | 无需额外代码 |
默认主题写法(Light 风格 + 主色配置):
<style name="AccountsLight" parent="MaterialNavigationDrawerTheme.Light.DarkActionBar">
<item name="colorPrimary">#8bc34a</item>
<item name="colorPrimaryDark">#558b2f</item>
</style>
Accounts 头部:addAccount() 添加账号
在 init() 中调用 addAccount(),MaterialAccount 构造参数依次为:Resources、昵称、邮箱、头像、背景图:
MaterialAccount account = new MaterialAccount(getResources(),
"NeoKree", "neokree@gmail.com", R.drawable.photo, R.drawable.bamboo);
this.addAccount(account);
添加多个账号后,点击头像区域即可弹出账号切换列表,切换时自带平滑缩放动画。监听账号切换可实现 MaterialAccountListener 并调用 setAccountListener(this),示例见 Accounts.java。
图片 / 自定义 / 无头部:改一个主题属性即可
把主题的 drawerType 改为 @integer/DRAWERTYPE_IMAGE,然后在 init() 中调用 setDrawerHeaderImage(R.drawable.xxx) 即可换成图片头部;改成 DRAWERTYPE_CUSTOM 则调用 setDrawerHeaderCustom(view) 塞入任意布局。示例分别位于 ImageDrawerHeader.java 和 CustomDrawerHeader.java。
四、进阶配置速查清单
| 需求 | 方法 / 配置 | 说明 |
|---|---|---|
| 启动时默认打开第 N 个 Section | setDefaultSectionLoaded(2) |
见 setDefaultSectionLoaded(),0 表示第一个 |
| 返回键回到首个 Section | setBackPattern(BACKPATTERN_BACK_TO_FIRST) |
支持 ANYWHERE / BACK_TO_FIRST / CUSTOM 三种模式 |
| 工具栏悬浮阴影 | enableToolbarElevation() |
见 源码 |
| 保持全局统一 Toolbar 色 | 主题 uniqueToolbarColor 设为 true |
忽略 Section 专属色 |
| 平板横屏常显抽屉 | 主题 multipaneSupport 设为 true |
抽屉固定在左侧,无需滑动 |
这些"功能开关"全部走主题属性,在 styles.xml 的 Functionality Themes 一节有完整示例。
五、新手避坑指南:2 个必知报错
🚫 报错 1:You must add at least one Section to top list.
init() 执行完一个 Section 都没加就会崩溃(源码检查点)。解决方法很简单:至少调用一次 addSection()。
🚫 报错 2:The first section added must have a fragment as target
第一个 Section 的目标必须是 Fragment 而不能是 Intent 或监听器,因为它是 App 启动后的默认页面(源码检查点)。把"首页"Fragment 放在第一位即可。
💡 小提示:首次启动时库会自动展开一次抽屉引导用户发现侧边栏(Learning Pattern),不喜欢的话在主题里把 learningPattern 设为 false 即可。
六、示例代码索引:跟着示例文件快速上手
| 示例文件 | 演示内容 |
|---|---|
| Test.java | 3 账号头部 + 多 Section 配色 + 运行时切换 |
| Accounts.java | 账号切换监听 + Bottom Section 跳 Activity |
| MockedAccount.java | 单账号最简配置 |
| DefaultSectionLoaded.java | 默认启动项配置 |
| MasterChildActivity.java | 主从页面嵌套流程 |
| styles.xml | 全部主题配置(Light / Dark / 功能开关) |
| MainActivity.java | 示例入口清单,逐项体验各功能 |
掌握"继承 → init() → 三步配置"这条主线后,一个标准的 Material 风格导航抽屉只需要不到 30 行代码,剩下交给库即可。
