众所周知。。环信巨坑哪~~~~不过最近找了条相对简单的捷径!!在这里简单做下小记,以便下次查阅。。
引入EaseUI
将
EaseUI
作为一个模块引入到项目中,引入之后需要注意其build.gradle
中依赖的第三方框架(比如glide
)的版本是否与项目其他模块版本一致,需要统一版本。
加入辅助工具类
在
com.hyphenate.easeui
下新建HxHelper
辅助类,具体作用如后文。内容如下
public class HxHelper {
//扩展消息-昵称
public static final String MSG_EXT_NICKNAME = "hx_nickname";
//扩展消息-头像
public static final String MSG_EXT_AVATAR = "hx_avatar";
private volatile static HxHelper instance;
public Application app;
public Opts mOpts;
//所有的会话集合
private Map<String, EMConversation> mConvMap;
private HxHelper() {
if (null != instance)
throw new IllegalStateException("Can not instantiate singleton class.");
}
/**
* 初始化
*
* @param application Application
* @param opts 配置项
*/
public void init(Application application, Opts opts) {
app = application;
mOpts = opts;
}
/**
* 单例模式
*
* @return 单例实例
*/
public static HxHelper getInstance() {
if (null == instance) {
synchronized (HxHelper.class) {
if (null == instance) {
instance = new HxHelper();
}
}
}
return instance;
}
public EaseUser getUser(String username) {
EaseUser user = new EaseUser(username);
//获取到所有会话
mConvMap = EMClient.getInstance().chatManager().getAllConversations();
if (null != mConvMap) {
List<EMMessage> msgList = null;
for (Map.Entry<String, EMConversation> et : mConvMap.entrySet()) {
msgList = et.getValue().getAllMessages();
//遍历消息列表,从消息扩展中获取昵称和头像
if (null != msgList && !msgList.isEmpty()) {
for (EMMessage msg : msgList) {
if (!TextUtils.equals(username, msg.getFrom())) {
//如果该条消息不是该用户的,就遍历下一条
continue;
}
//设置昵称和用户名
try {
user.setNickname(msg.getStringAttribute(MSG_EXT_NICKNAME));
user.setAvatar(msg.getStringAttribute(MSG_EXT_AVATAR));
} catch (Exception e) {
e.printStackTrace();
}
}
}
}
}
return user;
}
/**
* 配置项
*/
public static class Opts {
public boolean showChatTitle;
}
}
改变头像控件形状
若要将头像改为圆形或者圆角,就需要在
Application
的onCreate()
方法中添加如下代码
//设置头像为圆形
EaseAvatarOptions avatarOpts = new EaseAvatarOptions();
//0:默认,1:圆形,2:矩形
avatarOpts.setAvatarShape(1);
//设置倒角
//avatarOpts.setAvatarRadius(radius);
EaseUI.getInstance().setAvatarOptions(avatarOpts);
设置聊天界面
直接使用
EaseChatFragment
,具体代码如下
//new出EaseChatFragment或其子类的实例
EaseChatFragment chatFragment = new EaseChatFragment();
//传入参数
Bundle args = new Bundle();
args.putInt(EaseConstant.EXTRA_CHAT_TYPE, EaseConstant.CHATTYPE_GROUP);
args.putString(EaseConstant.EXTRA_USER_ID, "username");
chatFragment.setArguments(args);
getSupportFragmentManager().beginTransaction().add(R.id.container, chatFragment).commit();
其中
R.id.container
为显示该界面的容器,代码如下即可
<FrameLayout
android:id="@+id/fl_chat_content"
android:layout_width="match_parent"
android:layout_height="match_parent"/>
隐藏自带的标题栏
多数情况下,我们都有自己的标题栏,而引入的
EaseChatFragment
已经自带了个毁三观的标题栏,此时就需要将它隐藏。虽然EaseChatFragment
提供了隐藏和显示标题栏的方法,对这种直接使用EaseChatFragment
的方法不适用(原因下边分析),此时前面的HxHelper
就派上用场了。。
chatFragment.hideTitleBar();//无效,具体原因后面分析
- 第一步,需要在
Application
的onCreate()
方法中添加如下代码
//设置有关环信自定义的相关配置
HxHelper.Opts opts = new HxHelper.Opts();
opts.showChatTitle = false;
HxHelper.getInstance().init(this, opts);
- 第二步,打开
EaseChatFragment
,找到setUpView()
方法,在其末尾添加如下代码
//自定义代码,设置标题栏的显示与隐藏
if (HxHelper.getInstance().mOpts.showChatTitle) {
showTitleBar();
} else {
hideTitleBar();
}
到这里,头像形状就自定义成功了
- 前面说的调用
EaseChatFragment
的showTitleBar()
和hideTitleBar()
无效,主要原因如下
//注意这里的titleBar,该控件是在EaseChatFragment父类(EaseBaseFragment)中的onActivityCreated()方法中才获取到的,所以提交了事务之后就调用hideTitleBar()的话,titleBar是null的,所以设置无效。
//hideTitleBar()方法
public void hideTitleBar() {
if (titleBar != null) {
titleBar.setVisibility(View.GONE);
}
}
//获取到titleBar的地方(EaseBaseFragment中)
@Override
public void onActivityCreated(Bundle savedInstanceState) {
...
titleBar = (EaseTitleBar) getView().findViewById(R.id.title_bar);
...
}
设置头像和昵称之类信息
最简单的方法是通过扩展消息发送这些字段,然后通过
EaseUI.getInstance().setUserProfileProvider(EaseUserProfileProvider userProvider)
方法设置用户信息提供者,再在其getUser(String username)
方法中做手脚,不过这就需要借助其提供的接口EaseChatFragment.EaseChatFragmentHelper
来实现发送消息前带上扩展消息。具体代码如下
- 第一步,设置扩展消息辅助器
//定义辅助类实现EaseChatFragment.EaseChatFragmentHelper的onSetMessageAttributes(EMMessage message)方法
private class ChatHelper implements EaseChatFragment.EaseChatFragmentHelper {
@Override
public void onSetMessageAttributes(EMMessage message) {
User user = App.getInstance().getUserClone();
if (null == user) {
return;
}
//设置自己的头像和昵称到消息扩展中
message.setAttribute(HxHelper.MSG_EXT_NICKNAME, user.memberNickname);
message.setAttribute(HxHelper.MSG_EXT_AVATAR, user.memberAvatar);
}
}
//然后调用EaseChatFragment的setChatFragmentHelper(EaseChatFragment.EaseChatFragmentHelper helper)方法,设置辅助器即可
- 第二步,在
Application
的onCreate()
方法中设置EaseUserProfileProvider
,具体代码如下
EaseUI.getInstance().setUserProfileProvider(username -> {
User user = getUserClone();
//如果是当前用户,就设置自己的昵称和头像
if (null != user && TextUtils.equals(user.hxUsername, username)) {
EaseUser eu = new EaseUser(username);
eu.setNickname(user.memberNickname);
eu.setAvatar(user.memberAvatar);
return eu;
}
//否则交给HxHelper处理,从消息中获取昵称和头像
return HxHelper.getInstance().getUser(username);
});
到此,昵称和头像就能完美显示了~~
Android 7.0+ 拍照权限异常
众所周知,
Android 7.0+
拍照和图片裁剪要用FileProvider
,但一年过去了,环信貌似并不想做这方面的兼容(TNND
)。不过修改起来也不容易,在EaseChatFragment
中selectPicFromCamera()
方法中做修改。
- 第一步,先在
AndroidManifest.xml
的application
中注册FileProvider
,这里就直接在EaseUI
模块中做修改,在其AndroidManifest.xml
<application
android:allowBackup="true"
android:hardwareAccelerated="true"
android:supportsRtl="true">
<!--百度地图页面-->
<activity android:name="com.hyphenate.easeui.ui.EaseBaiduMapActivity"/>
<!--显示大图页面-->
<activity android:name="com.hyphenate.easeui.ui.EaseShowBigImageActivity"/>
<provider
android:name=".EsFileProvider"
android:authorities="com.hyphenate.easeui.provider"
android:exported="false"
android:grantUriPermissions="true">
<meta-data
android:name="android.support.FILE_PROVIDER_PATHS"
android:resource="@xml/file_path"/>
</provider>
</application>
- 第二步,再在
res
目录下新建xml
文件夹,再新建file_path.xml
,其内容为
<paths>
<external-path
name="external_files"
path="."/>
</paths>
- 第三步,在
EaseChatFragment
的selectPicFromCamera()
方法中找到如下代码
startActivityForResult(new Intent(MediaStore.ACTION_IMAGE_CAPTURE).putExtra(MediaStore.EXTRA_OUTPUT, Uri.fromFile(cameraFile)), REQUEST_CODE_CAMERA);
- 第四步, 将其修改为如下即可
//为了兼容Android 7.0+,使用FileProvider
Uri fileUri = null;
if (Build.VERSION.SDK_INT < Build.VERSION_CODES.N) {
//Android 7.0以下
fileUri = Uri.fromFile(cameraFile);
} else {
//Android 7.0及以上
fileUri = EsFileProvider.getUriForFile(getActivity(), "com.hyphenate.easeui.provider", cameraFile);
}
startActivityForResult(new Intent(MediaStore.ACTION_IMAGE_CAPTURE).putExtra(MediaStore.EXTRA_OUTPUT, fileUri), REQUEST_CODE_CAMERA);
到此,你已经成功跳过环信的巨坑,也爬出了其不少小坑~~