jetpack 学习笔记(ViewModel+ViewBinding+livedata+retrofit)

用jetpack框架编写了一个简易的网络请求流程,效果如下:


3.jpg

7.jpg

2.jpg
4.jpg

由于接口对接的是我们开发环境地址,所以我把地址相关的屏蔽了,见谅,这个接口对接的是整个app第一个接口获取token,有了这个token我们就可以作为用户的唯一ID去请求应用的其他接口,实现方式如下:
1、编写xml布局:

<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android"
    .......
</androidx.constraintlayout.widget.ConstraintLayout>

2、引入视图绑定viewbinding(用于替换butterkife),我不擅长xml里面去写双向绑定逻辑,所以这里没有用databinding;注意:视图绑定在 Android Studio 3.6 Canary 11 及更高版本中可用。首先在你需要启动绑定的module中声明:

android {
        ...
        viewBinding {
            enabled = true
        }
    }

然后在activity中进行初始化:

public class MainActivity extends BaseActivity {

    private ActivityMainBinding mainBinding;
    private LoginViewModel loginViewModel;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        mainBinding = ActivityMainBinding.inflate(getLayoutInflater());
        setContentView(mainBinding.getRoot());
        mainBinding.tvTitle.setText("jetpack 登录测试");

        //初始化viewModel
        loginViewModel = new ViewModelProvider(this,
                ViewModelProvider.AndroidViewModelFactory.getInstance(getApplication())).get(LoginViewModel.class);
        btLoginClick();
    }

    public void btLoginClick() {
        mainBinding.btLogin.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
              
            }
        });
    }

    @Override
    protected void onDestroy() {
        mainBinding = null;
        super.onDestroy();
    }

上述代码并没有调用任何layout文件,其实我们只要声明了viewbinding,我们的activity_main.xml文件会自动对应上生成类ActivityMainBinding;转换名称:xml名称的驼峰+Binding;当我们按住ctrl并用鼠标点击ActivityMainBinding时会自动跳转到activity_main.xml;并且我们在xml声明的控件id(android:id="@+id/tv_title"),可以通过mainBinding.tvTitle的形式进行调用;这样也避免了控件可能出现未初始化的问题。
仔细观察我们上面还添加了LoginViewModel ,我们当前需要通过它得到我们需要的数据,现在补全点击事件:

mainBinding.btLogin.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                Editable etPhone=mainBinding.etPhone.getText();
                Editable etPsw=mainBinding.etPsw.getText();
                if(etPhone==null||etPsw==null){
                    return;
                }
                String phone = etPhone.toString();
                String psw = etPsw.toString();
                LogUtil.e("yy----phone:"+phone+"\tpsw:"+psw);
                showLoadingDialog("登录中,请稍候");
                loginViewModel.getTokenEntityLiveData(phone, psw).observe(
                        MainActivity.this, new Observer<Resource<TokenEntity>>() {
                            @Override
                            public void onChanged(Resource<TokenEntity> resource) {
                                hideLoadingDialog();
                                resource.handle(new Resource.OnHandleCallback<TokenEntity>() {
                                    @Override
                                    public void onLoading() {
                                        LogUtil.e("yy---onLoading");
                                    }

                                    @Override
                                    public void onSuccess(TokenEntity data) {
                                        LogUtil.e("yy---token:" + data.toString());
                                    }

                                    @Override
                                    public void onFailure(String msg) {
                                        LogUtil.e("yy---onFailure:" + msg);
                                    }

                                    @Override
                                    public void onError(Throwable error) {
                                        LogUtil.e("yy---onError:" + error.getMessage());
                                    }

                                    @Override
                                    public void onCompleted() {
                                        LogUtil.d("yy---onCompleted");
                                    }
                                });
                            }
                        });
            }
        });

上面代码我们通过.observe(this, 观察者)绑定了观察者,在livedata 数据改变的时候会通知onChanged(){}回调方法进行刷新,resource.handle这个东西是自己对返回包装过后的,这个建议自己写,原本返回的东西是一个json 字符串,外面也包装了一个公共的状态壳子,如下:

{
    "data": {
        ....
    },
    "code": 0,
    "msg": "成功",
    "validate": ""
}

接着外面看下viewmodel层,里面持有

public class LoginViewModel extends AndroidViewModel {
    private TokenRepository repository;
    private MutableLiveData<Resource<TokenEntity>> liveData;

    public LoginViewModel(@NonNull Application application) {
        super(application);

        repository = TokenRepository.getInstance();
    }

    public MutableLiveData<Resource<TokenEntity>> getTokenEntityLiveData(String phone, String psw) {
        liveData = repository.getToken(phone, psw);
        return liveData;
    }

}

数据相关的对象官方建议外面都放在这里,比如liveData<pojo A>、liveData<pojo B>;它是这样说的:
  架构组件为界面控制器提供了 ViewModel 辅助程序类,该类负责为界面准备数据。在配置更改期间会自动保留 ViewModel 对象,以便它们存储的数据立即可供下一个 Activity 或 Fragment 实例使用。例如,如果您需要在应用中显示用户列表,请确保将获取和保留该用户列表的责任分配给 ViewModel,而不是 Activity 或 Fragment,
从界面控制器逻辑中分离出视图数据所有权的做法更易行且更高效。
ViewModel 里面外面还持有了一个数据帮助类对象TokenRepository,这个对象主要用于连接viewmodel和网路数据或者数据库数据或者其它数据来源,TokenRepository内部处理如下:

/**
     * 获取token  通过账号和密码
     *
     * @param username
     * @param password
     * @return
     */
    public MutableLiveData<Resource<TokenEntity>> getToken(String username, String password) {
        final MutableLiveData<Resource<TokenEntity>> liveData = new MutableLiveData<>();
        try {
            RequetTokenBody tokenBody = new RequetTokenBody();
            tokenBody.username = username;
            tokenBody.password = MD5Tool.md5Digest(password).toUpperCase();
            tokenBody.grant_type = "password";
            tokenBody.client_id = ConfigKey.CLIENT_ID;
            tokenBody.client_secret = ConfigKey.CLIENT_KEY;
            tokenBody.scope = "com.xx.xxxx.tv";
            BaseReqApi.getInstance().getService()
                    .getToken(tokenBody)
                    .enqueue(new Callback<BaseResult<TokenEntity>>() {
                        @Override
                        public void onResponse(Call<BaseResult<TokenEntity>> call, Response<BaseResult<TokenEntity>> response) {
                            liveData.setValue(Resource.response(response.body()));
                        }

                        @Override
                        public void onFailure(Call<BaseResult<TokenEntity>> call, Throwable t) {
                            liveData.setValue(Resource.error(t));
                        }
                    });
        } catch (Exception e) {
            e.printStackTrace();
        }
        return liveData;
    }

可以看到,我们网络真正的请求和返回是在这里处理的,
发送请求:是以json的格式进行请求的,我们配置了一个请求参数对象,然后调用retrofit请求参数配置注解BaseService:

public interface BaseService {
    /**
     * 登录
     *
     * @param
     * @return
     */
    @POST("oauth/token")
    Call<BaseResult<TokenEntity>> getToken(@Body RequetTokenBody body);

}

请求格式相关配置是在拦截器进行处理的,在发送请求前进行拦截:

/**
     * 获取接口实例
     */
    public BaseService getService() {
        OkHttpClient httpClient=new OkHttpClient.Builder()
                .connectTimeout(DEFAULT_TIME_OUT, TimeUnit.SECONDS)
                .readTimeout(DEFAULT_TIME_OUT,TimeUnit.SECONDS)
                .writeTimeout(DEFAULT_TIME_OUT,TimeUnit.SECONDS)
                .addInterceptor(new HeaderInterceptor())
//                .cookieJar(cookieJar)
                .build();
        Retrofit retrofit = new Retrofit.Builder()
                .baseUrl("http://xxx/zhloauth2-api-project/")
                .client(httpClient)
                .addConverterFactory(GsonConverterFactory.create())
                .build();

        return retrofit.create(BaseService.class);
    }
public class HeaderInterceptor implements Interceptor {
    @Override
    public Response intercept(Chain chain) throws IOException {
        String agent = UserAgentUtils.get(App.getContext());
        Request request = chain.request()
                .newBuilder()
                .removeHeader("User-Agent")
                .addHeader("Accept", "application/json")
                .addHeader("Connection", "Keep-Alive")
                .addHeader("Charset", "UTF-8")
                .addHeader("User-Agent", agent)
                .build();
        return chain.proceed(request);
    }
}

到这里,整个请求流程就基本结束了。demo还是比较简单,实际项目中肯定还需要对代码进行封装,对多种场景也需要分别处理。继续学习ing.

推荐阅读更多精彩内容