Android MVVM框架搭建OKHttp + Retrofit + RxJava

Posted 初学者-Study

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Android MVVM框架搭建OKHttp + Retrofit + RxJava相关的知识,希望对你有一定的参考价值。

前言

  在上一篇文章中,简单的介绍了MVVM框架的成员和简单使用,一个成熟的框架自然是离不开网络访问的,因此文本将通过Retrofit + RxJava去为MVVM框架增加一个网络请求模块。

正文

  让我们开始吧!说实话搭建框架首先要做的是创建一个library,但是我并没有这么做,不是不去做,而是还不成熟。现在这个框架还不完整,还少了很多实际开发中需要的东西。因此一个成熟的框架应该是经历过项目考验的,此时再从这个项目中去提炼出框架得到才是精华。就好像建房子一样。基础模型有了,最终的样子取决于你的装修,这些装修的工作里面也有通用的部分,这部分是可以放进框架里面的,所以当你打算做一个框架的时候,千万不要着急。立足于实践,从实践中积累经验。当然了你要是直接用别人写好的框架,也能够去解决问题。这一点也是可以的,但是会不踏实。只有自己百分百写出来的东西,自己才能知根知底。说这些的意义是要注重实践和思考,拿来主义并不可取。

一、引入依赖

  要知道做完GitHub上Android的最受欢迎的开源库,Retrofit的知名度毋庸置疑,这得益于它的设计模式和使用方式。它作为OkHttp的进一步封装无疑是很成功的。虽然底层去执行网络访问的还是OkHttp,但是我们却更喜欢Retrofit。下面进入使用的环节。首先要进行依赖库的引入。

在app的build.gradle的dependencies闭包中增加如下依赖:

	//retrofit2
    implementation 'com.squareup.retrofit2:retrofit:2.9.0'
    implementation 'com.squareup.retrofit2:converter-gson:2.9.0'
    //日志拦截器
    implementation 'com.squareup.okhttp3:logging-interceptor:3.10.0'
    implementation 'com.squareup.retrofit2:adapter-rxjava2:2.4.0'
    //rxjava
    implementation 'io.reactivex.rxjava2:rxandroid:2.1.1'
    implementation 'io.reactivex.rxjava2:rxjava:2.2.12'
    //gson
    implementation 'com.google.code.gson:gson:2.8.7'

添加位置如下图所示:

然后点击Sync Now,进行依赖库同步。

二、工具类

  在实际的网络请求中会需要打印日志和一些请求时间的显示,方便排查问题,下面在com.llw.mvvm下新建一个network包,包下新建一个INetworkRequiredInfo接口,里面的代码如下:

public interface INetworkRequiredInfo 
    /**
     * 获取App版本名
     */
    String getAppVersionName();

    /**
     * 获取App版本号
     */
    String getAppVersionCode();

    /**
     * 判断是否为Debug模式
     */
    boolean isDebug();

    /**
     * 获取全局上下文参数
     */
    Application getApplicationContext();

这里就是要在请求网络接口的时候打印当前的App的运行信息,可以根据实际的需求再进行一次补充。

在network包下新建一个utils包,包下新建一个DateUtil类,代码如下:

public class DateUtil 
    public static final String STANDARD_TIME = "yyyy-MM-dd HH:mm:ss";
    public static final String FULL_TIME = "yyyy-MM-dd HH:mm:ss.SSS";
    public static final String YEAR_MONTH_DAY = "yyyy-MM-dd";
    public static final String YEAR_MONTH_DAY_CN = "yyyy年MM月dd号";
    public static final String HOUR_MINUTE_SECOND = "HH:mm:ss";
    public static final String HOUR_MINUTE_SECOND_CN = "HH时mm分ss秒";
    public static final String YEAR = "yyyy";
    public static final String MONTH = "MM";
    public static final String DAY = "dd";
    public static final String HOUR = "HH";
    public static final String MINUTE = "mm";
    public static final String SECOND = "ss";
    public static final String MILLISECOND = "SSS";
    public static final String YESTERDAY = "昨天";
    public static final String TODAY = "今天";
    public static final String TOMORROW = "明天";
    public static final String SUNDAY = "星期日";
    public static final String MONDAY = "星期一";
    public static final String TUESDAY = "星期二";
    public static final String WEDNESDAY = "星期三";
    public static final String THURSDAY = "星期四";
    public static final String FRIDAY = "星期五";
    public static final String SATURDAY = "星期六";
    public static final String[] weekDays = SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY;

    /**
     * 获取标准时间
     *
     * @return 例如 2021-07-01 10:35:53
     */
    public static String getDateTime() 
        return new SimpleDateFormat(STANDARD_TIME, Locale.CHINESE).format(new Date());
    

    /**
     * 获取完整时间
     *
     * @return 例如 2021-07-01 10:37:00.748
     */
    public static String getFullDateTime() 
        return new SimpleDateFormat(FULL_TIME, Locale.CHINESE).format(new Date());
    

    /**
     * 获取年月日(今天)
     *
     * @return 例如 2021-07-01
     */
    public static String getTheYearMonthAndDay() 
        return new SimpleDateFormat(YEAR_MONTH_DAY, Locale.CHINESE).format(new Date());
    

    /**
     * 获取年月日
     *
     * @return 例如 2021年07月01号
     */
    public static String getTheYearMonthAndDayCn() 
        return new SimpleDateFormat(YEAR_MONTH_DAY_CN, Locale.CHINESE).format(new Date());
    

    /**
     * 获取年月日
     * @param delimiter 分隔符
     * @return 例如 2021年07月01号
     */
    public static String getTheYearMonthAndDayDelimiter(CharSequence delimiter) 
        return new SimpleDateFormat(YEAR + delimiter + MONTH + delimiter + DAY, Locale.CHINESE).format(new Date());
    

    /**
     * 获取时分秒
     *
     * @return 例如 10:38:25
     */
    public static String getHoursMinutesAndSeconds() 
        return new SimpleDateFormat(HOUR_MINUTE_SECOND, Locale.CHINESE).format(new Date());
    

    /**
     * 获取时分秒
     *
     * @return 例如 10时38分50秒
     */
    public static String getHoursMinutesAndSecondsCn() 
        return new SimpleDateFormat(HOUR_MINUTE_SECOND_CN, Locale.CHINESE).format(new Date());
    

    /**
     * 获取时分秒
     * @param delimiter 分隔符
     * @return 例如 2021/07/01
     */
    public static String getHoursMinutesAndSecondsDelimiter(CharSequence delimiter) 
        return new SimpleDateFormat(HOUR + delimiter + MINUTE + delimiter + SECOND, Locale.CHINESE).format(new Date());
    

    /**
     * 获取年
     *
     * @return 例如 2021
     */
    public static String getYear() 
        return new SimpleDateFormat(YEAR, Locale.CHINESE).format(new Date());
    

    /**
     * 获取月
     *
     * @return 例如 07
     */
    public static String getMonth() 
        return new SimpleDateFormat(MONTH, Locale.CHINESE).format(new Date());
    

    /**
     * 获取天
     *
     * @return 例如 01
     */
    public static String getDay() 
        return new SimpleDateFormat(DAY, Locale.CHINESE).format(new Date());
    

    /**
     * 获取小时
     *
     * @return 例如 10
     */
    public static String getHour() 
        return new SimpleDateFormat(HOUR, Locale.CHINESE).format(new Date());
    

    /**
     * 获取分钟
     *
     * @return 例如 40
     */
    public static String getMinute() 
        return new SimpleDateFormat(MINUTE, Locale.CHINESE).format(new Date());
    

    /**
     * 获取秒
     *
     * @return 例如 58
     */
    public static String getSecond() 
        return new SimpleDateFormat(SECOND, Locale.CHINESE).format(new Date());
    

    /**
     * 获取毫秒
     *
     * @return 例如 666
     */
    public static String getMilliSecond() 
        return new SimpleDateFormat(MILLISECOND, Locale.CHINESE).format(new Date());
    

    /**
     * 获取时间戳
     *
     * @return 例如 1625107306051
     */
    public static long getTimestamp() 
        return System.currentTimeMillis();
    

    /**
     * 将时间转换为时间戳
     *
     * @param time 例如 2021-07-01 10:44:11
     * @return 1625107451000
     */
    public static long dateToStamp(String time) 
        SimpleDateFormat simpleDateFormat = new SimpleDateFormat(STANDARD_TIME, Locale.CHINESE);
        Date date = null;
        try 
            date = simpleDateFormat.parse(time);
         catch (ParseException e) 
            e.printStackTrace();
        
        return Objects.requireNonNull(date).getTime();
    

    /**
     * 将时间戳转换为时间
     *
     * @param timeMillis 例如 1625107637084
     * @return 例如 2021-07-01 10:47:17
     */
    public static String stampToDate(long timeMillis) 
        return new SimpleDateFormat(STANDARD_TIME, Locale.CHINESE).format(new Date(timeMillis));
    

    /**
     * 获取今天是星期几
     *
     * @return 例如 星期四
     */
    public static String getTodayOfWeek() 
        Calendar cal = Calendar.getInstance();
        cal.setTime(new Date());
        int index = cal.get(Calendar.DAY_OF_WEEK) - 1;
        if (index < 0) 
            index = 0;
        
        return weekDays[index];
    

    /**
     * 根据输入的日期时间计算是星期几
     *
     * @param dateTime 例如 2021-06-20
     * @return 例如 星期日
     */
    public static String getWeek(String dateTime) 
        Calendar cal = Calendar.getInstance();
        if ("".equals(dateTime)) 
            cal.setTime(new Date(System.currentTimeMillis()));
         else 
            SimpleDateFormat sdf = new SimpleDateFormat(YEAR_MONTH_DAY, Locale.getDefault());
            Date date;
            try 
                date = sdf.parse(dateTime);
             catch (ParseException e) 
                date = null;
                e.printStackTrace();
            
            if (date != null) 
                cal.setTime(new Date(date.getTime()));
            
        
        return weekDays[cal.get(Calendar.DAY_OF_WEEK) - 1];
    

    /**
     * 获取输入日期的昨天
     *
     * @param date 例如 2021-07-01
     * @return 例如 2021-06-30
     */
    public static String getYesterday(Date date) 
        Calendar calendar = new GregorianCalendar();
        calendar.setTime(date);
        calendar.add(Calendar.DATE, -1);
        date = calendar.getTime();
        return new SimpleDateFormat(YEAR_MONTH_DAY, Locale.getDefault()).format(date);
    

    /**
     * 获取输入日期的明天
     *
     * @param date 例如 2021-07-01
     * @return 例如 2021-07-02
     */
    public static String getTomorrow(Date date) 
        Calendar calendar = new GregorianCalendar();
        calendar.setTime(date);
        calendar.add(Calendar.DATE, +1);
        date = calendar.getTime();
        return new SimpleDateFormat(YEAR_MONTH_DAY, Locale.getDefault()).format(date);
    

    /**
     * 根据年月日计算是星期几并与当前日期判断  非昨天、今天、明天 则以星期显示
     *
     * @param dateTime 例如 2021-07-03
     * @return 例如 星期六
     */
    public static String getDayInfo(String dateTime) 
        String dayInfo;
        String yesterday = getYesterday(new Date());
        String today = getTheYearMonthAndDay();
        String tomorrow = getTomorrow(new Date());

        if (dateTime.equals(yesterday)) 
            dayInfo = YESTERDAY;
         else if (dateTime.equals(today)) 
            dayInfo = TODAY;
         else if (dateTime.equals(tomorrow)) 
            dayInfo = TOMORROW;
         else 
            dayInfo = getWeek(dateTime);
        
        return dayInfo;
    

    /**
     * 获取本月天数
     *
     * @return 例如 31
     */
    public static int getCurrentMonthDays() 
        Calendar calendar = Calendar.getInstance();
        //把日期设置为当月第一天
        calendar.set(Calendar.DATE, 1);
        //日期回滚一天,也就是最后一天
        calendar.roll(Calendar.DATE, -1);
        return calendar.get(Calendar.DATE);
    

    /**
     * 获得指定月的天数
     *
     * @param year  例如 2021
     * @param month 例如 7
     * @return 例如 31
     */
    public static int getMonthDays(int year, int month) 
        Calendar calendar = Calendar.getInstance();
        calendar.set(Calendar.YEAR, year);
        calendar.set(Calendar.MONTH, month - 1);
        //把日期设置为当月第一天
        calendar.set(Calendar.DATE, 1);
        //日期回滚一天,也就是最后一天
        calendar.roll(Calendar.DATE, -1);
        return calendar.get(Calendar.DATE);
    

日志工具类,在utils包下新建KLog类,代码如下:

/**
 * 自定义日志类
 */
public final class KLog 

    private static boolean IS_SHOW_LOG = true;

    private static final String DEFAULT_MESSAGE = "execute";
    private static final String LINE_SEPARATOR = System.getProperty("line.separator");
    private static final int JSON_INDENT = 4;

    private static final int V = 0x1;
    private static final int D = 0x2;
    private static final int I = 0x3;
    private static final int W = 0x4;
    private static final int E = 0x5;
    private static final int A = 0x6;
    private static final int JSON = 0x7;

    public static void init(boolean isShowLog) 
        IS_SHOW_LOG = isShowLog;
    

    public static void v() 
        printLog(V, null, DEFAULT_MESSAGE);
    

    public static void v(以上是关于Android MVVM框架搭建OKHttp + Retrofit + RxJava的主要内容,如果未能解决你的问题,请参考以下文章

高仿Android网易云音乐OkHttp+Retrofit+RxJava+Glide+MVC+MVVM

Android MVVM框架搭建ViewModel + LiveData + DataBinding

Android MVVM框架搭建ViewModel + LiveData + DataBinding

RxAndroid+RxJava+Gson+retrofit+okhttp初步搭建android网络请求框架

Android MVVM框架搭建高德地图定位天气查询BottomSheetDialog

Android MVVM框架搭建HiltViewBindingActivity Result API