Android DataSource 层实现

2024-06-15 13:18
文章标签 实现 android datasource

本文主要是介绍Android DataSource 层实现，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

前言

在 Android 日益成熟和完善的阶段,我们的项目也日益的开始注重性能和可维护性.今天要和大家聊一聊Android 项目里面的 DataSource

首先我们可以理解 DataSource 是一个单独的 Module,可以对外提供很多的数据操作
- 网络请求
- 本地的一些数据的持久化
- 一些第三方的数据封装
- 项目中一些Runtime的数据(比如用户信息,是否登录了等等)

目标架构

在我们的项目中,我们希望我们在使用 DataSource 的时候是可以使用一个,全部的地方都使用这一个. 但是我们又希望在我们维护 DataSource 的时候是可以分成多个来写的

这里写图片描述

实现这个架构

因为这样子不仅使用方便,更便于维护,但是要实现这样子的架构,却不太好实现.
假设我们现在要提供一个 ShareadPrefrence 存储的 DataSource 和 城市列表的数据的 DataSource

你写了一个 SpDataSource 接口和一个 SpDataSourceImpl 实现类
又写了一个 CityDataSource 接口和一个 CityDataSourceImpl 实现类

但是我们希望我们使用的时候是使用一个总的 DataSource

那你现在如何让一个总的 DataSource 拥有各个DataSource 的功能呢？

使用动态代理

你可以写一个 DataSource 接口继承所有的其他的 DataSource 接口

class DataSource extends DataSource1,DataSource2..... {
}

然后使用动态代理代理这个 DataSource 接口,然后在代理的拦截方法中判断方法的归属的类,然后调用相应的 DataSourceImpl

使用动态代理的弊端(我开始采取的就是这个方案)

  • 调试的时候, DataSource 实现类的 代码调试不了
  • 每一次有一个新的 DataSource,我就得修改 DataSource 总接口和代理中的代码

其中最为致命的还是低一点调试不了,所以我就开始寻求另一个方式来实现

使用代码生成

还记得之前说的目标吗？我们要实现使用的时候是一个 DataSource ,维护的是时候是多个 DataSource

如果我们能扫描到所有的 DataSource,并且让每一个 DataSource 中的方法都生成到 一个总的 DataSource 接口和 DataSource 实现类,那么问题不就解决了吗？

还有一个小问题,每一个子 DataSource 中方法还可能有和其他子 DataSource 名字重复的方法,所以生成的时候应该支持给每一个子 DataSource 添加一个前缀

这里就可以使用注解驱动器来实现啦

这里写图片描述

类似于这种用注解标记这个 DataSource 接口,标明实现类

这里写图片描述

最终会生成这三个类,一个总的 DataSource 接口,一个总的 DataSource 实现类 和 一个 DataSource 的管理类

最终代码实现

先写一个注解类
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.CLASS)
public @interface EHiDataSourceAnno {/*** 生成的方法的前缀,用于区分** @return*/String value() default "";/*** 用于内部区分,不能为相同的** @return*/String uniqueCode();/*** 实现类,会被加入到缓存中*/String impl() default "";/*** 如果实现类不是直接创建的,那么传入调用的方式** @return*/String callPath() default "";}
编写对应的 AnnotationProcessor
/*** 实现项目中的 retrofit 接口的代理接口和实现类生成,生成的类作为 datasource 层* time   : 2018/08/10** @author : xiaojinzi 30212*/
@AutoService(Processor.class)
@SupportedSourceVersion(SourceVersion.RELEASE_7)
@SupportedAnnotationTypes({"com.ehi.api.EHiDataSourceAnno"})
public class EHiDatasourceProcessor extends AbstractProcessor {private TypeMirror typeString;private TypeMirror typeVoid;private Filer mFiler;private Messager mMessager;private Types mTypes;private Elements mElements;private String classNameApi = "com.ehi.datasource.DataSourceApi";private String classNameApiImpl = "com.ehi.datasource.DataSourceApiImpl";private String classNameApiManager = "com.ehi.datasource.DataSourceManager";;@Overridepublic synchronized void init(ProcessingEnvironment processingEnvironment) {super.init(processingEnvironment);mFiler = processingEnv.getFiler();mMessager = processingEnvironment.getMessager();mTypes = processingEnv.getTypeUtils();mElements = processingEnv.getElementUtils();typeString = mElements.getTypeElement("java.lang.String").asType();typeVoid = mElements.getTypeElement("java.lang.Void").asType();}@Overridepublic boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {if (CollectionUtils.isNotEmpty(set)) {Set<? extends Element> routeElements = roundEnvironment.getElementsAnnotatedWith(EHiDataSourceAnno.class);parseAnno(routeElements);return true;}return false;}/*** 解析注解** @param currElements*/private void parseAnno(Set<? extends Element> currElements) {List<TypeElement> list = new ArrayList<>();Set<String> prefixSet = new HashSet<>();Set<String> uniqueSet = new HashSet<>();for (Element element : currElements) {TypeMirror tm = element.asType();if (!(element instanceof TypeElement)) {mMessager.printMessage(Diagnostic.Kind.ERROR, element + " is not a 'TypeElement' ");continue;}EHiDataSourceAnno anno = element.getAnnotation(EHiDataSourceAnno.class);if (anno.impl().isEmpty() && anno.callPath().isEmpty()) {mMessager.printMessage(Diagnostic.Kind.ERROR, element.toString() + ": EHiDataSourceAnno's impl and EHiDataSourceAnno's callPath are both empty");continue;}if (!anno.value().isEmpty()) {if (prefixSet.contains(anno.value())) {mMessager.printMessage(Diagnostic.Kind.ERROR, element.toString() + ": EHiDataSourceAnno's value is already exist");continue;}prefixSet.add(anno.value());}if (uniqueSet.contains(anno.uniqueCode())) {mMessager.printMessage(Diagnostic.Kind.ERROR, element.toString() + ": EHiDataSourceAnno's uniqueCode is not unique");continue;}uniqueSet.add(anno.uniqueCode());list.add((TypeElement) element);}try {createDataSourceApi(list);createDataSourceApiManager(list);createDataSourceApiImpl(list);} catch (Exception e) {mMessager.printMessage(Diagnostic.Kind.ERROR, "createDataSource fail: " + e.getMessage());e.printStackTrace();}}private void createDataSourceApi(List<TypeElement> apiClassList) throws IOException {// pkgString pkgApi = classNameApi.substring(0, classNameApi.lastIndexOf("."));// simpleNameString cnApi = classNameApi.substring(classNameApi.lastIndexOf(".") + 1);TypeSpec.Builder typeSpecBuilder = TypeSpec.interfaceBuilder(cnApi).addModifiers(Modifier.PUBLIC);typeSpecBuilder.addJavadoc("所有用注解标记的DataSource都会被整合到这里\n\n");for (TypeElement typeElement : apiClassList) {EHiDataSourceAnno remoteAnno = typeElement.getAnnotation(EHiDataSourceAnno.class);if (remoteAnno == null) {continue;}typeSpecBuilder.addJavadoc("@see " + typeElement.toString() + "\n");generateMethods(typeElement.getEnclosedElements(), typeSpecBuilder, remoteAnno, false);}TypeSpec typeSpec = typeSpecBuilder.build();JavaFile.builder(pkgApi, typeSpec).indent("    ").build().writeTo(mFiler);}private void createDataSourceApiManager(List<TypeElement> apiClassList) throws IOException {// pkgString pkgApi = classNameApiManager.substring(0, classNameApiManager.lastIndexOf("."));// simpleNameString cnApi = classNameApiManager.substring(classNameApiManager.lastIndexOf(".") + 1);TypeSpec.Builder typeSpecBuilder = TypeSpec.classBuilder(cnApi).addModifiers(Modifier.PUBLIC);ClassName mapClassName = ClassName.get("java.util", "Map");TypeName typeNameMap = ParameterizedTypeName.get(mapClassName, TypeName.get(typeString), TypeName.get(mElements.getTypeElement("java.lang.Object").asType()));FieldSpec.Builder mapFieldSpecBuilder = FieldSpec.builder(typeNameMap, "map", Modifier.PRIVATE).initializer("java.util.Collections.synchronizedMap(new java.util.HashMap<String,Object>())");typeSpecBuilder.addField(mapFieldSpecBuilder.build());for (TypeElement typeElement : apiClassList) {EHiDataSourceAnno anno = typeElement.getAnnotation(EHiDataSourceAnno.class);if (anno == null || anno.impl().isEmpty()) {continue;}TypeMirror returnType = typeElement.asType();MethodSpec.Builder methodSpecBuilder = MethodSpec.methodBuilder(anno.uniqueCode() + "DataSource").returns(TypeName.get(returnType));String implClassName = anno.impl();methodSpecBuilder.addStatement(implClassName + " value = (" + implClassName + ") map.get(\"" + anno.uniqueCode() + "\");").beginControlFlow("if (value == null)").addStatement("value = " + " new " + implClassName + "()").addStatement("map.put(\"" + anno.uniqueCode() + "\", value);").endControlFlow().addStatement("return value").addModifiers(Modifier.PUBLIC);MethodSpec methodSpec = methodSpecBuilder.build();typeSpecBuilder.addMethod(methodSpec);}// 内部的Holder 静态类TypeSpec.Builder typeSpecHolderBuilder = TypeSpec.classBuilder("Holder").addModifiers(Modifier.PUBLIC, Modifier.STATIC);typeSpecHolderBuilder.addField(FieldSpec.builder(ClassName.get(classNameApiManager.substring(0, classNameApiManager.lastIndexOf(".")), classNameApiManager.substring(classNameApiManager.lastIndexOf(".") + 1)), "instance").initializer("new " + classNameApiManager + "()").addModifiers(Modifier.PUBLIC, Modifier.STATIC, Modifier.FINAL).build());TypeSpec apiTypeSpec = typeSpecBuilder// 添加一个私有的构造函数.addMethod(MethodSpec.constructorBuilder().addModifiers(Modifier.PRIVATE).build()).addType(typeSpecHolderBuilder.build()).build();JavaFile.builder(pkgApi, apiTypeSpec).indent("    ").build().writeTo(mFiler);}private void createDataSourceApiImpl(List<TypeElement> apiClassList) throws IOException {// pkgString pkg = classNameApiImpl.substring(0, classNameApiImpl.lastIndexOf("."));// simpleNameString cn = classNameApiImpl.substring(classNameApiImpl.lastIndexOf(".") + 1);TypeSpec.Builder typeSpecBuilder = TypeSpec.classBuilder(cn).addModifiers(Modifier.PUBLIC);for (TypeElement typeElement : apiClassList) {EHiDataSourceAnno remoteAnno = typeElement.getAnnotation(EHiDataSourceAnno.class);if (remoteAnno == null) {continue;}List<? extends Element> enclosedElements = typeElement.getEnclosedElements();generateMethods(enclosedElements, typeSpecBuilder, remoteAnno, true);}ClassName superInterface = ClassName.get(classNameApi.substring(0, classNameApi.lastIndexOf(".")), classNameApi.substring(classNameApi.lastIndexOf(".") + 1));typeSpecBuilder.addSuperinterface(superInterface);TypeSpec typeSpec = typeSpecBuilder.build();JavaFile.builder(pkg, typeSpec).indent("    ").build().writeTo(mFiler);}private void generateMethods(List<? extends Element> enclosedElements, TypeSpec.Builder typeSpecBuilder, EHiDataSourceAnno anno, boolean isAddStatement) {for (Element elementItem : enclosedElements) {if (!(elementItem instanceof ExecutableElement)) {continue;}// 可执行的方法ExecutableElement executableElement = (ExecutableElement) elementItem;String methodName = "";if (anno.value().isEmpty()) {methodName = executableElement.getSimpleName().toString();} else {methodName = anno.value() + firstCharToUp(executableElement.getSimpleName().toString());}MethodSpec.Builder methodSpecBuilder = MethodSpec.methodBuilder(methodName);String parameterStr = generateParameters(executableElement, methodSpecBuilder);methodSpecBuilder.returns(TypeName.get(executableElement.getReturnType()));if (isAddStatement) {methodSpecBuilder.addModifiers(Modifier.PUBLIC);String returnStr = null;if (anno.callPath().isEmpty()) {returnStr = classNameApiManager + ".Holder.instance." + anno.uniqueCode() + "DataSource()." + executableElement.getSimpleName().toString() + "(" + parameterStr + ")";} else {returnStr = anno.callPath() + "." + executableElement.getSimpleName().toString() + "(" + parameterStr + ")";}if ("void".equals(executableElement.getReturnType().toString())) {methodSpecBuilder.addStatement(returnStr);} else {methodSpecBuilder.addStatement("return " + returnStr);}} else {methodSpecBuilder.addModifiers(Modifier.PUBLIC, Modifier.ABSTRACT);}MethodSpec methodSpec = methodSpecBuilder.build();typeSpecBuilder.addMethod(methodSpec);}}private String generateParameters(ExecutableElement executableElement, MethodSpec.Builder methodSpecBuilder) {List<? extends VariableElement> typeParameters = executableElement.getParameters();StringBuffer sb = new StringBuffer();for (VariableElement typeParameter : typeParameters) {//mMessager.printMessage(Diagnostic.Kind.NOTE, "typeParameter ====== " + typeParameter.asType().toString());//TypeName.get(mElements.getTypeElement(""))TypeName typeName = TypeName.get(typeParameter.asType());String parameterName = typeParameter.getSimpleName().toString();ParameterSpec parameterSpec = ParameterSpec.builder(typeName, parameterName).build();if (sb.length() == 0) {sb.append(parameterName);} else {sb.append(",").append(parameterName);}methodSpecBuilder.addParameter(parameterSpec);}return sb.toString();}private String firstCharToUp(String str) {if (str == null || str.length() == 0) {return "";}String str1 = str.substring(0, 1).toUpperCase();String str2 = str.substring(1);return str1 + str2;}}

源码下载

DataSourceImpl

这篇关于Android DataSource 层实现的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1063562。

相关文章

windos server2022里的DFS配置的实现

windos server2022里的DFS配置的实现

《windosserver2022里的DFS配置的实现》DFS是WindowsServer操作系统提供的一种功能,用于在多台服务器上集中管理共享文件夹和文件的分布式存储解决方案,本文就来介绍一下wi... 目录什么是DFS？优势：应用场景：DFS配置步骤什么是DFS？DFS指的是分布式文件系统（Distr
阅读更多...
NFS实现多服务器文件的共享的方法步骤

NFS实现多服务器文件的共享的方法步骤

《NFS实现多服务器文件的共享的方法步骤》NFS允许网络中的计算机之间共享资源,客户端可以透明地读写远端NFS服务器上的文件,本文就来介绍一下NFS实现多服务器文件的共享的方法步骤,感兴趣的可以了解一... 目录一、简介二、部署1、准备1、服务端和客户端：安装nfs-utils2、服务端：创建共享目录3、服
阅读更多...
C#使用yield关键字实现提升迭代性能与效率

C#使用yield关键字实现提升迭代性能与效率

《C#使用yield关键字实现提升迭代性能与效率》yield关键字在C#中简化了数据迭代的方式,实现了按需生成数据,自动维护迭代状态,本文主要来聊聊如何使用yield关键字实现提升迭代性能与效率,感兴... 目录前言传统迭代和yield迭代方式对比yield延迟加载按需获取数据yield break显式示迭
阅读更多...
Python实现高效地读写大型文件

Python实现高效地读写大型文件

《Python实现高效地读写大型文件》Python如何读写的是大型文件,有没有什么方法来提高效率呢,这篇文章就来和大家聊聊如何在Python中高效地读写大型文件,需要的可以了解下... 目录一、逐行读取大型文件二、分块读取大型文件三、使用 mmap 模块进行内存映射文件操作（适用于大文件）四、使用 pand
阅读更多...
python实现pdf转word和excel的示例代码

python实现pdf转word和excel的示例代码

《python实现pdf转word和excel的示例代码》本文主要介绍了python实现pdf转word和excel的示例代码,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价... 目录一、引言二、python编程1，PDF转Word2，PDF转Excel三、前端页面效果展示总结一
阅读更多...
Python xmltodict实现简化XML数据处理

Python xmltodict实现简化XML数据处理

《Pythonxmltodict实现简化XML数据处理》Python社区为提供了xmltodict库,它专为简化XML与Python数据结构的转换而设计,本文主要来为大家介绍一下如何使用xmltod... 目录一、引言二、XMLtodict介绍设计理念适用场景三、功能参数与属性1、parse函数2、unpa
阅读更多...
C#实现获得某个枚举的所有名称

C#实现获得某个枚举的所有名称

《C#实现获得某个枚举的所有名称》这篇文章主要为大家详细介绍了C#如何实现获得某个枚举的所有名称,文中的示例代码讲解详细,具有一定的借鉴价值,有需要的小伙伴可以参考一下... C#中获得某个枚举的所有名称using System;using System.Collections.Generic;usi
阅读更多...
Go语言实现将中文转化为拼音功能

Go语言实现将中文转化为拼音功能

《Go语言实现将中文转化为拼音功能》这篇文章主要为大家详细介绍了Go语言中如何实现将中文转化为拼音功能,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 有这么一个需求：新用户入职 创建一系列账号比较麻烦，打算通过接口传入姓名进行初始化。想把姓名转化成拼音。因为有些账号即需要中文也需要英
阅读更多...
C# 读写ini文件操作实现

C# 读写ini文件操作实现

《C#读写ini文件操作实现》本文主要介绍了C#读写ini文件操作实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧... 目录一、INI文件结构二、读取INI文件中的数据在C#应用程序中，常将INI文件作为配置文件，用于存储应用程序的
阅读更多...
C#实现获取电脑中的端口号和硬件信息

C#实现获取电脑中的端口号和硬件信息

《C#实现获取电脑中的端口号和硬件信息》这篇文章主要为大家详细介绍了C#实现获取电脑中的端口号和硬件信息的相关方法,文中的示例代码讲解详细,有需要的小伙伴可以参考一下... 我们经常在使用一个串口软件的时候，发现软件中的端口号并不是普通的COM1，而是带有硬件信息的。那么如果我们使用C#编写软件时候，如
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2