diff --git a/app/src/main/java/com/monke/monkeybook/BitIntentDataManager.java b/app/src/main/java/com/monke/monkeybook/BitIntentDataManager.java index 139f98f..c59ce0c 100644 --- a/app/src/main/java/com/monke/monkeybook/BitIntentDataManager.java +++ b/app/src/main/java/com/monke/monkeybook/BitIntentDataManager.java @@ -4,15 +4,34 @@ package com.monke.monkeybook; import java.util.HashMap; import java.util.Map; +/** + * BitIntentDataManager类主要用于管理意图（Intent）相关的数据，采用了单例设计模式来确保在整个应用程序中只有一个实例存在， + * 方便在不同的组件之间共享和操作这些数据，例如在不同的Activity、Fragment之间传递数据时，可以通过这个类来统一管理传递的数据内容。 + */ public class BitIntentDataManager { - public static Map bigData; + /** + * 使用静态变量bigData来存储数据，它是一个Map类型，其中键（String类型）用于唯一标识不同的数据项，值（Object类型）可以是任意类型的对象， + * 通过这种键值对的形式，可以方便地存储和获取各种不同类型的数据，用于传递和共享意图相关的数据信息。 + */ + public static Map bigData; + + /** + * 静态私有变量instance，用于保存BitIntentDataManager类的唯一实例，初始值为null，通过单例模式的相关逻辑来确保只有在第一次调用时才会创建实例，后续都复用这个实例。 + */ private static BitIntentDataManager instance = null; - public static BitIntentDataManager getInstance(){ - if(instance == null){ - synchronized (BitIntentDataManager.class){ - if(instance == null){ + /** + * 静态方法，用于获取BitIntentDataManager类的唯一实例，实现了单例模式中的获取实例逻辑。 + * 首先判断instance是否为null，如果是则进入同步代码块（使用synchronized关键字保证在多线程环境下只会有一个线程创建实例）， + * 在同步代码块内再次检查instance是否为null，若仍为null则创建一个新的BitIntentDataManager实例并赋值给instance，最后返回这个唯一的实例。 + * 这样可以保证无论在多少个地方调用这个方法，整个应用程序中始终只有一个BitIntentDataManager实例在运行。 + * @return 返回BitIntentDataManager类的唯一实例对象，通过该实例可以调用其他方法来操作意图数据。 + */ + public static BitIntentDataManager getInstance() { + if (instance == null) { + synchronized (BitIntentDataManager.class) { + if (instance == null) { instance = new BitIntentDataManager(); } } @@ -20,16 +39,40 @@ public class BitIntentDataManager { return instance; } - private BitIntentDataManager(){ + /** + * 私有构造函数，用于创建BitIntentDataManager类的实例对象，在构造函数内部会初始化bigData这个用于存储数据的Map对象， + * 使得实例创建时就准备好了用于存放意图相关数据的数据结构，同时私有构造函数也符合单例模式的设计要求，限制了外部直接创建实例的方式，只能通过getInstance方法获取实例。 + */ + private BitIntentDataManager() { bigData = new HashMap<>(); } - public Object getData(String key){ + + /** + * 根据传入的键（key）从bigData这个存储数据的Map中获取对应的值（Object类型），用于获取之前存储的意图相关数据， + * 如果键不存在，则返回null，外部代码可以通过这个方法获取需要的数据进行后续的业务逻辑处理，例如在接收意图传递的数据后获取具体的值进行展示等操作。 + * @param key 用于查找数据的键，是一个字符串类型，需要与之前存储数据时使用的键保持一致，以便准确获取对应的意图数据。 + * @return 返回从bigData中获取到的对应键的值（Object类型），如果键不存在则返回null。 + */ + public Object getData(String key) { return bigData.get(key); } - public void putData(String key,Object data){ - bigData.put(key,data); + + /** + * 将指定的键（key）和对应的数据（Object类型）存储到bigData这个Map中，用于添加意图相关的数据，方便在不同组件间传递数据时进行数据的设置操作， + * 例如在一个组件中准备好要传递的数据，通过这个方法存储后，其他组件就可以通过相应的键来获取这些数据了。 + * @param key 用于标识存储数据的键，是一个字符串类型，需要保证其唯一性，以便后续准确地通过该键来获取对应的数据，通常根据意图数据的业务含义来定义合适的键名。 + * @param data 要存储的Object类型的数据，即需要传递和共享的具体数据内容，可以是各种类型的对象，如字符串、自定义对象等。 + */ + public void putData(String key, Object data) { + bigData.put(key, data); } - public void cleanData(String key){ + + /** + * 根据传入的键（key）从bigData这个存储数据的Map中移除对应的键值对，用于清理不再需要的意图相关数据， + * 例如在某个数据已经被接收并处理完后，或者不再需要传递该数据时，可以通过这个方法将其从存储中移除，释放内存空间并避免数据冗余等问题。 + * @param key 用于查找并移除数据的键，是一个字符串类型，需要与之前存储数据时使用的键保持一致，以便准确移除对应的意图数据。 + */ + public void cleanData(String key) { bigData.remove(key); } -} +} \ No newline at end of file diff --git a/app/src/main/java/com/monke/monkeybook/ErrorAnalyContentManager.java b/app/src/main/java/com/monke/monkeybook/ErrorAnalyContentManager.java index a08608f..0b9dca1 100644 --- a/app/src/main/java/com/monke/monkeybook/ErrorAnalyContentManager.java +++ b/app/src/main/java/com/monke/monkeybook/ErrorAnalyContentManager.java @@ -12,16 +12,36 @@ import io.reactivex.ObservableOnSubscribe; import io.reactivex.android.schedulers.AndroidSchedulers; import io.reactivex.schedulers.Schedulers; +/** + * ErrorAnalyContentManager类主要用于管理与错误分析相关内容的写入操作，例如将出现错误的URL信息记录到本地文件中， + * 采用了单例设计模式，确保在整个应用程序中只有一个实例来处理这些错误相关的文件写入逻辑，方便统一管理错误记录的操作。 + */ public class ErrorAnalyContentManager { - private ErrorAnalyContentManager(){ + + /** + * 私有构造函数，将构造函数私有化，防止外部直接通过构造函数创建类的实例，符合单例模式的设计要求， + * 使得实例的创建只能通过类提供的静态方法 `getInstance` 来进行控制。 + */ + private ErrorAnalyContentManager() { } + + /** + * 静态私有变量，用于保存ErrorAnalyContentManager类的唯一实例，初始值为null，通过单例模式的相关逻辑来决定何时创建实例，确保整个应用中只有一个实例存在。 + */ private static ErrorAnalyContentManager instance; - public static ErrorAnalyContentManager getInstance(){ - if(instance == null){ - synchronized (ErrorAnalyContentManager.class){ - if(instance == null){ + /** + * 静态方法，用于获取ErrorAnalyContentManager类的唯一实例，实现了单例模式中的获取实例逻辑。 + * 首先判断 `instance` 是否为null，如果是则进入同步代码块（使用 `synchronized` 关键字保证在多线程环境下只会有一个线程创建实例）， + * 在同步代码块内再次检查 `instance` 是否为null，若仍为null则创建一个新的ErrorAnalyContentManager实例并赋值给 `instance`，最后返回这个唯一的实例。 + * 这样可以保证无论在多少个地方调用这个方法，整个应用程序中始终只有一个ErrorAnalyContentManager实例在运行。 + * @return 返回ErrorAnalyContentManager类的唯一实例对象，通过该实例可以调用其他方法来进行错误分析相关内容的写入操作。 + */ + public static ErrorAnalyContentManager getInstance() { + if (instance == null) { + synchronized (ErrorAnalyContentManager.class) { + if (instance == null) { instance = new ErrorAnalyContentManager(); } } @@ -29,97 +49,149 @@ public class ErrorAnalyContentManager { return instance; } - public void writeNewErrorUrl(final String url){ + /** + * 用于将新的错误相关的URL信息写入到本地文件中，这个方法会将URL信息按照特定的格式和逻辑分别写入到不同的文件中，用于后续的错误分析等操作。 + * 整个写入操作是基于RxJava的异步操作来实现的，通过 `Observable` 来创建异步任务，并指定了合适的线程调度器来保证在后台线程进行文件读写操作，在主线程进行结果回调处理。 + * @param url 表示出现错误的URL字符串，需要将其记录到本地文件中，用于后续对错误相关情况的分析排查等用途。 + */ + public void writeNewErrorUrl(final String url) { + // 创建一个Observable对象，用于定义一个异步可观察的操作序列，这里传入一个实现了ObservableOnSubscribe接口的匿名内部类，用于定义具体的操作逻辑（即文件写入等操作） Observable.create(new ObservableOnSubscribe() { @Override public void subscribe(ObservableEmitter e) throws Exception { + // 获取应用程序的外部文件目录路径，这个路径是应用在外部存储中可以进行读写操作的目录，用于存放相关的错误记录文件 String filePath = MApplication.getInstance().getExternalFilesDir("").getPath(); + // 根据获取到的文件路径创建一个File对象，表示文件所在的目录，后续用于判断目录是否存在以及创建目录等操作 File dir = new File(filePath); - if(!dir.exists()){ + // 判断目录是否不存在，如果不存在则创建该目录，确保后续要写入的文件所在目录是存在的，避免出现文件写入失败的情况 + if (!dir.exists()) { dir.mkdirs(); } - File file2 = new File(filePath,"ErrorAnalyUrlsDetail.txt"); - if(!file2.exists()) { + // 创建一个表示具体文件的File对象，这里的文件名为 "ErrorAnalyUrlsDetail.txt"，位于前面获取到的文件路径下，用于详细记录每个出现错误的完整URL信息 + File file2 = new File(filePath, "ErrorAnalyUrlsDetail.txt"); + // 判断这个文件是否不存在，如果不存在则创建一个新的空文件，为后续写入错误URL信息做准备 + if (!file2.exists()) { file2.createNewFile(); } - FileOutputStream fileOutputStream2 = new FileOutputStream(file2,true); - fileOutputStream2.write((url+" \r\n").getBytes()); + // 创建一个文件输出流对象，用于向 "ErrorAnalyUrlsDetail.txt" 文件写入数据，第二个参数true表示以追加模式打开文件，即新写入的数据会添加在文件末尾，而不会覆盖原有内容 + FileOutputStream fileOutputStream2 = new FileOutputStream(file2, true); + // 将传入的URL字符串加上特定的格式（后面添加几个空格和换行符）转换为字节数组后写入到文件中，实现将错误URL信息记录到文件的操作 + fileOutputStream2.write((url + " \r\n").getBytes()); + // 刷新输出流缓冲区，确保数据真正写入到文件中，而不是仅仅停留在缓冲区 fileOutputStream2.flush(); + // 关闭文件输出流，释放相关资源，避免资源泄漏 fileOutputStream2.close(); /////////////////////////////////////////////////////////////////////// - File file1 = new File(filePath,"ErrorAnalyUrls.txt"); - if(!file1.exists()) { + // 创建另一个表示文件的File对象，这里的文件名为 "ErrorAnalyUrls.txt"，同样位于前面获取到的文件路径下，这个文件可能用于记录一些经过处理后的错误URL相关信息（比如截取部分URL内容等情况） + File file1 = new File(filePath, "ErrorAnalyUrls.txt"); + // 判断这个文件是否不存在，如果不存在则创建一个新的空文件 + if (!file1.exists()) { file1.createNewFile(); } + // 创建一个文件输入流对象，用于读取 "ErrorAnalyUrls.txt" 文件中的内容，后续会根据读取到的内容进行相应处理（比如判断是否已存在相同的部分URL等情况） FileInputStream inputStream = new FileInputStream(file1); + // 创建一个字节数组，用于临时存储每次从文件中读取到的数据，这里指定了数组大小为1024字节，可根据实际情况调整合适的大小 byte[] bytes = new byte[1024]; + // 创建一个字节数组输出流对象，用于将从文件输入流中读取到的字节数据进行整合，方便后续将其转换为字符串进行处理 ByteArrayOutputStream arrayOutputStream = new ByteArrayOutputStream(); - while (inputStream.read(bytes) != -1) { + // 通过循环不断从文件输入流中读取数据，每次读取的数据存储到bytes字节数组中，直到读取到文件末尾（返回值为 -1 表示文件末尾），将读取到的数据写入到字节数组输出流中 + while (inputStream.read(bytes)!= -1) { arrayOutputStream.write(bytes, 0, bytes.length); } + // 关闭文件输入流，释放相关资源 inputStream.close(); + // 关闭字节数组输出流，释放相关资源，注意在关闭之前，其内部已经整合好了从文件中读取到的所有字节数据 arrayOutputStream.close(); + // 将字节数组输出流中的字节数据转换为字符串，这样就获取到了 "ErrorAnalyUrls.txt" 文件中的文本内容，方便后续进行字符串相关的判断操作 String content = new String(arrayOutputStream.toByteArray()); - if(!content.contains(url.substring(0,url.indexOf('/',8)))){ - FileOutputStream fileOutputStream1 = new FileOutputStream(file1,true); - fileOutputStream1.write((url.substring(0,url.indexOf('/',8))+" \r\n").getBytes()); + // 判断转换后的文件内容字符串中是否不包含当前要写入的URL的部分内容（这里截取了URL从开头到第8个字符后出现的第一个'/'之前的部分内容，具体截取逻辑根据业务需求而定），如果不包含则表示这个部分URL还未记录过 + if (!content.contains(url.substring(0, url.indexOf('/', 8)))) { + // 创建一个文件输出流对象，用于向 "ErrorAnalyUrls.txt" 文件写入数据，同样以追加模式打开文件 + FileOutputStream fileOutputStream1 = new FileOutputStream(file1, true); + // 将截取后的部分URL字符串加上特定的格式（后面添加几个空格和换行符）转换为字节数组后写入到文件中，实现将部分错误URL信息记录到文件的操作 + fileOutputStream1.write((url.substring(0, url.indexOf('/', 8)) + " \r\n").getBytes()); + // 刷新输出流缓冲区，确保数据真正写入到文件中 fileOutputStream1.flush(); + // 关闭文件输出流，释放相关资源 fileOutputStream1.close(); } + // 发送一个布尔值为true的数据给下游观察者，表示当前的异步操作（文件写入等操作）已经成功完成了这一步骤，触发下游的相关逻辑（比如 `onNext` 方法的调用等） e.onNext(true); + // 发送一个完成信号给下游观察者，表示整个异步操作已经全部完成，触发下游的 `onComplete` 方法调用等相关逻辑 e.onComplete(); } }) + // 指定这个Observable所代表的异步操作在IO线程（用于处理输入输出相关的耗时操作，如文件读写等）上执行，通过线程调度器来实现合适的线程切换，提高应用的性能和响应性 .subscribeOn(Schedulers.io()) + // 指定下游观察者（即处理异步操作结果的相关逻辑代码所在的地方）在Android的主线程上执行，这样可以方便在主线程更新UI等操作，符合Android开发中关于UI操作必须在主线程的要求 .observeOn(AndroidSchedulers.mainThread()) + // 订阅这个Observable，传入一个SimpleObserver对象，用于处理异步操作过程中产生的数据（通过 `onNext` 方法）、错误（通过 `onError` 方法）以及操作完成（通过 `onComplete` 方法）等不同情况的逻辑 .subscribe(new SimpleObserver() { @Override public void onNext(Boolean value) { - + // 当上游的Observable发送数据（这里是发送了布尔值为true的数据）时，会调用这个方法，当前方法体为空，可以根据业务需求在这里添加相应的逻辑，比如进行一些简单的日志记录等操作，表示文件写入操作的某一步骤成功完成了 } @Override public void onError(Throwable e) { - + // 当在异步操作过程中出现错误（比如文件读写出现异常等情况）时，会调用这个方法，当前方法体为空，可以在这里添加相应的错误处理逻辑，比如记录错误日志、提示用户等操作 } }); } - public void writeMayByNetError(final String url){ + /** + * 用于将可能是网络错误相关的URL信息写入到本地文件中，同样是基于RxJava的异步操作来实现文件写入，将指定的URL信息按照特定格式追加到名为 "ErrorNetUrl.txt" 的文件中，方便后续对网络错误相关情况进行分析排查等操作。 + * @param url 表示可能出现网络错误的URL字符串，需要将其记录到本地文件中，用于后续对网络错误相关情况的分析排查等用途。 + */ + public void writeMayByNetError(final String url) { Observable.create(new ObservableOnSubscribe() { @Override public void subscribe(ObservableEmitter e) throws Exception { + // 获取应用程序的外部文件目录路径，用于确定要写入的文件所在的目录位置 String filePath = MApplication.getInstance().getExternalFilesDir("").getPath(); + // 根据获取到的文件路径创建一个File对象，表示文件所在的目录，后续用于判断目录是否存在以及创建目录等操作 File dir = new File(filePath); - if(!dir.exists()){ + // 判断目录是否不存在，如果不存在则创建该目录，确保后续要写入的文件所在目录是存在的，避免出现文件写入失败的情况 + if (!dir.exists()) { dir.mkdirs(); } - File file = new File(filePath,"ErrorNetUrl.txt"); - if(!file.exists()) { + // 创建一个表示具体文件的File对象，文件名为 "ErrorNetUrl.txt"，位于前面获取到的文件路径下，用于记录可能出现网络错误的URL信息 + File file = new File(filePath, "ErrorNetUrl.txt"); + // 判断这个文件是否不存在，如果不存在则创建一个新的空文件，为后续写入错误URL信息做准备 + if (!file.exists()) { file.createNewFile(); } - FileOutputStream fileOutputStream2 = new FileOutputStream(file,true); - fileOutputStream2.write((url+" \r\n").getBytes()); + // 创建一个文件输出流对象，用于向 "ErrorNetUrl.txt" 文件写入数据，以追加模式打开文件，使得新写入的数据添加在文件末尾，不会覆盖原有内容 + FileOutputStream fileOutputStream2 = new FileOutputStream(file, true); + // 将传入的URL字符串加上特定的格式（后面添加几个空格和换行符）转换为字节数组后写入到文件中，实现将网络错误相关的URL信息记录到文件的操作 + fileOutputStream2.write((url + " \r\n").getBytes()); + // 刷新输出流缓冲区，确保数据真正写入到文件中，而不是仅仅停留在缓冲区 fileOutputStream2.flush(); + // 关闭文件输出流，释放相关资源，避免资源泄漏 fileOutputStream2.close(); + // 发送一个布尔值为true的数据给下游观察者，表示当前的异步操作（文件写入等操作）已经成功完成了这一步骤，触发下游的相关逻辑（比如 `onNext` 方法的调用等） e.onNext(true); + // 发送一个完成信号给下游观察者，表示整个异步操作已经全部完成，触发下游的 `onComplete` 方法调用等相关逻辑 e.onComplete(); } }) + // 指定这个Observable所代表的异步操作在IO线程上执行，通过线程调度器实现合适的线程切换，让文件读写等耗时操作在后台线程进行，提高应用性能和响应性 .subscribeOn(Schedulers.io()) + // 指定下游观察者（即处理异步操作结果的相关逻辑代码所在的地方）在Android的主线程上执行，方便在主线程进行UI更新等操作，符合Android开发中关于UI操作必须在主线程的要求 .observeOn(AndroidSchedulers.mainThread()) + // 订阅这个Observable，传入一个SimpleObserver对象，用于处理异步操作过程中产生的数据（通过 `onNext` 方法）、错误（通过 `onError` 方法）以及操作完成（通过 `onComplete` 方法）等不同情况的逻辑 .subscribe(new SimpleObserver() { @Override public void onNext(Boolean value) { - + // 当上游的Observable发送数据（这里是发送了布尔值为true的数据）时，会调用这个方法，当前方法体为空，可以根据业务需求在这里添加相应的逻辑，比如进行一些简单的日志记录等操作，表示文件写入操作的某一步骤成功完成了 } @Override public void onError(Throwable e) { - + // 当在异步操作过程中出现错误（比如文件读写出现异常等情况）时，会调用这个方法，当前方法体为空，可以在这里添加相应的错误处理逻辑，比如记录错误日志、提示用户等操作 } }); } -} +} \ No newline at end of file diff --git a/app/src/main/java/com/monke/monkeybook/MApplication.java b/app/src/main/java/com/monke/monkeybook/MApplication.java index 61e1345..744ccbb 100644 --- a/app/src/main/java/com/monke/monkeybook/MApplication.java +++ b/app/src/main/java/com/monke/monkeybook/MApplication.java @@ -8,31 +8,48 @@ import android.content.pm.PackageManager; import com.monke.monkeybook.service.DownloadService; import com.umeng.analytics.MobclickAgent; +// MApplication类继承自Android的Application类，是整个应用程序的全局基础类，用于在应用启动时进行一些初始化操作，例如配置统计分析工具、启动相关服务等 public class MApplication extends Application { + // 定义一个静态变量instance，用于保存MApplication类的唯一实例，方便在整个应用的其他地方可以获取到这个唯一的Application实例对象，实现全局访问 private static MApplication instance; + // 重写Application类的onCreate方法，这个方法会在应用程序启动时被系统自动调用，用于执行应用的初始化相关逻辑 @Override public void onCreate() { super.onCreate(); + + // 判断当前应用是否是发布版本（BuildConfig.IS_RELEASE通常是一个根据构建配置生成的布尔值，用于区分开发环境和发布环境），如果是发布版本则执行以下初始化操作 if (BuildConfig.IS_RELEASE) { + // 初始化一个默认的渠道名为"debug"，后续会尝试从应用的元数据中获取真实的渠道名来替换它，如果获取失败则保留这个默认值，这里的渠道名通常用于统计分析等工具区分应用的不同发布渠道来源 String channel = "debug"; try { + // 通过应用的包管理器（PackageManager）获取当前应用的ApplicationInfo信息，GET_META_DATA标志表示要获取应用的元数据信息，这一步是为了后续能从元数据中查找特定的渠道相关配置信息 ApplicationInfo appInfo = getPackageManager() .getApplicationInfo(getPackageName(), PackageManager.GET_META_DATA); + // 从获取到的ApplicationInfo的元数据中尝试获取名为"UMENG_CHANNEL_VALUE"的字符串值，这个值通常在应用的配置文件（如AndroidManifest.xml或相关的构建配置中设置）中定义，代表友盟统计分析工具所使用的渠道值 channel = appInfo.metaData.getString("UMENG_CHANNEL_VALUE"); } catch (PackageManager.NameNotFoundException e) { + // 如果在获取元数据过程中出现NameNotFoundException异常（通常是因为指定的元数据键不存在等原因），则打印异常堆栈信息，方便排查问题，同时保持前面设置的默认渠道名"debug"不变 e.printStackTrace(); } + // 使用获取到的渠道名以及其他相关配置信息（如友盟的App Key等）来初始化友盟统计分析工具（MobclickAgent），配置应用的统计相关行为，例如指定应用的上下文（this代表当前的MApplication实例）、友盟的App Key（通过getString(R.string.umeng_key)获取，通常在资源文件中定义）、渠道名、场景类型（这里是普通场景）以及是否自动统计页面停留时间等参数 MobclickAgent.startWithConfigure(new MobclickAgent.UMAnalyticsConfig(this, getString(R.string.umeng_key), channel, MobclickAgent.EScenarioType.E_UM_NORMAL, true)); } + + // 将当前的MApplication实例赋值给静态变量instance，使得在应用的其他地方可以通过getInstance方法获取到这个唯一的Application实例对象，实现全局访问 instance = this; + + // 调用ProxyManager类的initProxy方法（具体功能需看ProxyManager类的实现，可能是初始化一些代理相关设置等）进行相关初始化操作，这一步可能是应用自定义的初始化逻辑的一部分，用于处理网络代理等相关功能的初始化 ProxyManager.initProxy(); + + // 创建一个启动DownloadService服务的意图（Intent），并通过startService方法启动这个服务，DownloadService可能是用于处理应用中文件下载等相关功能的服务，启动它可以让相关下载逻辑在后台运行，保证下载任务等的持续执行 startService(new Intent(this, DownloadService.class)); } + // 定义一个静态方法，用于获取MApplication类的唯一实例，方便在应用的其他地方获取到这个全局的Application实例对象，进而可以访问在Application中定义的全局变量、调用相关方法等 public static MApplication getInstance() { return instance; } -} +} \ No newline at end of file diff --git a/app/src/main/java/com/monke/monkeybook/ProxyManager.java b/app/src/main/java/com/monke/monkeybook/ProxyManager.java index eb1248d..2cbd21c 100644 --- a/app/src/main/java/com/monke/monkeybook/ProxyManager.java +++ b/app/src/main/java/com/monke/monkeybook/ProxyManager.java @@ -1,67 +1,136 @@ package com.monke.monkeybook; import android.content.SharedPreferences; - import org.jsoup.helper.StringUtil; - import java.util.regex.Pattern; +// ProxyManager类主要用于管理应用程序中的代理相关设置，包括代理的状态（是否启用代理）以及代理的HTTP地址等信息， +// 同时提供了保存、初始化这些设置以及检查是否存在有效代理的方法，通过与SharedPreferences交互实现设置的持久化存储。 public class ProxyManager { + + // 定义一个常量字符串，作为在SharedPreferences中存储HTTP代理地址的键，方便后续通过这个键来获取和设置对应的代理地址值， + // 遵循统一的命名规范以便代码的可读性和维护性。 public static final String SP_KEY_PROXY_HTTP = "proxy_http"; + + // 定义一个常量字符串，作为在SharedPreferences中存储代理状态（布尔值，表示是否启用代理）的键， + // 用于准确标识和操作代理状态相关的存储数据。 public static final String SP_KEY_PROXY_STATE = "proxy_state"; + + // 定义一个默认的HTTP代理地址值，初始为空字符串，表示没有设置代理地址时的默认情况， + // 当获取代理地址且未进行过设置或者设置被清除时，会返回这个默认值。 public static final String PROXY_HTTP_DEFAULT = ""; + + // 定义一个默认的代理状态值，初始为false，表示默认情况下代理是未启用的， + // 作为代理状态在没有从存储中获取到有效数据或者初始化时的默认设置。 public static final boolean PROXY_STATE_DEFAULT = false; + // 静态变量，用于存储当前应用的代理状态（是否启用代理），可在类的各个方法中访问和修改， + // 通过与存储的交互以及相关方法的调用保持其值与实际的代理设置情况一致。 public static boolean proxyState; + + // 静态变量，用于存储当前应用的HTTP代理地址，方便在需要使用代理进行网络请求等操作时获取该地址信息， + // 其值会根据用户设置以及从存储中读取的情况进行更新。 public static String proxyHttp; - private static final String PROXY_HTTP_MATCH = "(http|ftp|https):\\/\\/[\\w\\-_]+(\\.[\\w\\-_]+)+([\\w\\-\\.,@?^=%&:/~\\+#]*[\\w\\-\\@?^=%&/~\\+#])?";//http正则表达式 - public static final String PROXY_PACKAGENAME_ENCODE = "代理包名加密key"; //代理包名加密key - public static String packageName; //加密后的包名 + // 定义一个用于匹配HTTP代理地址格式的正则表达式字符串，用于验证输入或存储的代理地址是否符合规范， + // 涵盖了常见的HTTP、HTTPS、FTP协议开头的网络地址格式情况，以便对代理地址进行合法性校验。 + private static final String PROXY_HTTP_MATCH = "(http|ftp|https):\\/\\/[\\w\\-_]+(\\.[\\w\\-_]+)+([\\w\\-\\.,@?^=%&:/~\\+#]*[\\w\\-\\@?^=%&/~\\+#])?"; + + // 定义一个常量字符串，用于表示代理包名加密的密钥，具体加密相关功能可能在其他地方实现， + // 这里只是定义了这个密钥的常量表示，用于相关的加密操作或者与加密相关逻辑的标识。 + public static final String PROXY_PACKAGENAME_ENCODE = "代理包名加密key"; + + // 静态变量，用于存储加密后的包名信息，具体加密过程以及其用途取决于应用中与代理相关的业务逻辑， + // 例如可能用于身份验证、权限控制等涉及到包名相关的代理功能场景中。 + public static String packageName; + + // 用于保存代理状态到SharedPreferences中的方法，接收一个布尔值参数表示要设置的代理状态， + // 同时更新类中的静态变量proxyState，确保内存中的状态与存储中的设置保持一致。 public static void saveProxyState(boolean state) { + // 将传入的代理状态值赋给静态变量proxyState，使其在内存中更新为最新的设置值。 proxyState = state; + // 获取应用程序的SharedPreferences对象的编辑器（Editor），用于后续对存储数据进行修改操作， + // "CONFIG"是SharedPreferences文件的名称，0表示操作模式（MODE_PRIVATE，即只有当前应用可以访问该文件）。 SharedPreferences.Editor editor = MApplication.getInstance().getSharedPreferences("CONFIG", 0).edit(); + // 通过编辑器将代理状态值（proxyState）以指定的键（SP_KEY_PROXY_STATE）存储到SharedPreferences中，实现数据的持久化保存。 editor.putBoolean(SP_KEY_PROXY_STATE, proxyState); + // 提交编辑器中的修改操作，将数据真正写入到SharedPreferences文件中，使设置生效。 editor.commit(); } + // 私有方法，用于初始化代理状态信息，主要从SharedPreferences中获取之前存储的代理状态值， + // 如果获取失败则使用默认的代理状态值（PROXY_STATE_DEFAULT），同时尝试获取应用的包名信息（可能用于后续相关逻辑）。 private static void initProxyState() { try { + // 通过应用的包管理器（PackageManager）获取当前应用的包名信息，将获取到的包名赋值给静态变量packageName， + // 具体用途可能与代理相关的权限判断、标识等功能有关，这里先进行获取并存储以备后续使用。 packageName = MApplication.getInstance().getPackageManager().getPackageInfo(MApplication.getInstance().getPackageName(), 0).packageName; } catch (Exception e) { + // 如果在获取包名过程中出现异常（例如找不到对应包信息等情况），则打印异常堆栈信息，方便排查问题， + // 同时在控制台输出提示信息，表示包名获取失败可能会影响代理请求功能，让开发者知晓潜在问题。 e.printStackTrace(); System.out.println("=================包名获取失败，可能会影响代理请求功能================="); } + // 从应用的SharedPreferences中获取代理状态值，以SP_KEY_PROXY_STATE为键进行查找， + // 如果不存在对应的键值对，则使用默认的代理状态值（PROXY_STATE_DEFAULT）作为初始值赋给proxyState变量，实现代理状态的初始化。 proxyState = MApplication.getInstance().getSharedPreferences("CONFIG", 0).getBoolean(SP_KEY_PROXY_STATE, PROXY_STATE_DEFAULT); } + // 用于保存HTTP代理地址到SharedPreferences中的方法，接收一个字符串参数表示要设置的代理地址， + // 同时更新类中的静态变量proxyHttp，保证内存中的代理地址与存储中的设置一致。 public static void saveProxyHttp(String http) { + // 将传入的代理地址值赋给静态变量proxyHttp，使其在内存中更新为最新的设置值。 proxyHttp = http; + // 获取应用程序的SharedPreferences对象的编辑器（Editor），用于后续对存储数据进行修改操作， + // "CONFIG"是SharedPreferences文件的名称，0表示操作模式（MODE_PRIVATE，即只有当前应用可以访问该文件）。 SharedPreferences.Editor editor = MApplication.getInstance().getSharedPreferences("CONFIG", 0).edit(); + // 通过编辑器将代理地址值（proxyHttp）以指定的键（SP_KEY_PROXY_HTTP）存储到SharedPreferences中，实现数据的持久化保存。 editor.putString(SP_KEY_PROXY_HTTP, proxyHttp); + // 提交编辑器中的修改操作，将数据真正写入到SharedPreferences文件中，使设置生效。 editor.commit(); } + // 私有方法，用于初始化HTTP代理地址信息，从SharedPreferences中获取之前存储的代理地址值， + // 如果获取失败则使用默认的代理地址值（PROXY_HTTP_DEFAULT），以此来完成代理地址的初始化设置。 private static void initProxyHttp() { + // 从应用的SharedPreferences中获取代理地址值，以SP_KEY_PROXY_HTTP为键进行查找， + // 如果不存在对应的键值对，则使用默认的代理地址值（PROXY_HTTP_DEFAULT）作为初始值赋给proxyHttp变量，实现代理地址的初始化。 proxyHttp = MApplication.getInstance().getSharedPreferences("CONFIG", 0).getString(SP_KEY_PROXY_HTTP, PROXY_HTTP_DEFAULT); } + // 用于整体初始化代理相关设置的方法，会依次调用初始化代理地址和初始化代理状态的方法， + // 然后调用hasProxy方法来检查当前设置的代理是否有效，完成整个代理相关设置的初始化流程。 public static void initProxy() { + // 调用initProxyHttp方法，初始化HTTP代理地址信息，从存储中获取或设置默认的代理地址值到内存变量中。 initProxyHttp(); + // 调用initProxyState方法，初始化代理状态信息，从存储中获取或设置默认的代理状态值到内存变量中。 initProxyState(); + // 调用hasProxy方法，检查当前设置的代理是否有效，根据代理状态和代理地址的合法性进行判断， + // 并根据判断结果可能更新代理状态的存储值，确保代理设置的准确性。 hasProxy(); } + // 用于检查当前是否存在有效代理的方法，根据代理状态以及代理地址是否符合格式要求来综合判断， + // 如果代理未启用或者代理地址不符合规范，则返回false，表示不存在有效代理；否则返回true，表示存在有效代理， + // 同时在代理地址不符合规范时会自动将代理状态设置为false并保存到存储中，以保证代理设置的合理性。 public static boolean hasProxy() { + // 如果代理状态为false（即代理未启用），直接返回false，表示不存在有效代理，无需再进行地址格式验证等操作。 if (!proxyState) { return false; } + // 使用定义好的正则表达式字符串（PROXY_HTTP_MATCH）创建一个Pattern对象，用于后续对代理地址进行格式匹配验证， + // Pattern类提供了强大的正则表达式匹配功能，方便判断输入的字符串是否符合特定的格式要求。 Pattern pattern = Pattern.compile(PROXY_HTTP_MATCH); + // 通过StringUtil.isBlank方法检查代理地址（proxyHttp）是否为空（包含空字符串、null以及只包含空白字符等情况）， + // 并且使用创建的Pattern对象对代理地址进行正则匹配验证，只有当代理地址不为空且符合格式要求时，才返回true，表示存在有效代理； + // 否则返回false，表示代理地址不符合规范，不存在有效代理。 if (!StringUtil.isBlank(proxyHttp) && pattern.matcher(proxyHttp).matches()) { return true; } else { + // 如果代理地址不符合规范，调用saveProxyState方法将代理状态设置为false，表示当前不存在有效代理， + // 并将这个更新后的代理状态保存到SharedPreferences中，确保存储中的代理状态与实际情况一致，然后返回false。 saveProxyState(false); return false; } } -} +} \ No newline at end of file diff --git a/app/src/main/java/com/monke/monkeybook/ReadBookControl.java b/app/src/main/java/com/monke/monkeybook/ReadBookControl.java index f88e7d3..625b1c3 100644 --- a/app/src/main/java/com/monke/monkeybook/ReadBookControl.java +++ b/app/src/main/java/com/monke/monkeybook/ReadBookControl.java @@ -9,169 +9,255 @@ import java.util.HashMap; import java.util.List; import java.util.Map; +/** + * ReadBookControl类主要用于管理阅读书籍时的相关控制参数，例如文字大小、文字颜色、背景样式以及翻页方式等设置， + * 采用单例模式设计，确保在整个应用中只有一个实例来统一管理这些阅读相关的配置信息，方便在不同的阅读场景中进行参数的获取和更新操作。 + */ public class ReadBookControl { + + // 定义默认的文字样式索引值，用于在没有特定设置或者初始化时确定默认使用的文字相关配置，这里值为2，具体对应哪种文字样式由后续的逻辑决定。 public static final int DEFAULT_TEXT = 2; + + // 定义默认的背景样式索引值，用于在没有特定设置或者初始化时确定默认使用的背景相关配置，这里值为1，同样具体对应哪种背景样式由后续逻辑决定。 public static final int DEFAULT_BG = 1; - private static List> textKind; - private static List> textDrawable; + // 用于存储不同文字样式相关配置信息的列表，每个元素是一个Map，其中包含如文字大小、文字间距等具体配置项，方便根据不同索引获取对应的文字样式配置。 + private static List> textKind; + + // 用于存储不同文字绘制相关配置信息的列表（主要涉及文字颜色和文字背景相关设置），每个元素是一个Map，方便根据不同索引获取对应的文字绘制相关配置。 + private static List> textDrawable; + // 记录当前的文字大小，单位可能是像素等（具体取决于存储和使用的情况），通过获取对应文字样式配置中的值来初始化和更新，用于控制阅读界面文字显示的大小。 private int textSize; + + // 记录当前的文字间距（额外间距），单位可能是像素等，通过对应文字样式配置获取并更新，用于调整文字排版时的间距效果，提升阅读体验。 private int textExtra; + + // 记录当前的文字颜色，以颜色值的形式存储（可能是通过Android系统的颜色表示方式，如ARGB等），从文字绘制相关配置中获取，决定文字在阅读界面呈现的颜色。 private int textColor; + + // 记录当前的文字背景，以资源标识符（如R.drawable中的相关资源ID）的形式存储，用于指定文字所在区域的背景样式，从文字绘制相关配置中获取并应用。 private int textBackground; + // 当前选择的文字样式索引，用于在textKind列表中定位对应的文字样式配置，初始化为DEFAULT_TEXT，可通过设置方法进行更新，以切换不同的文字样式。 private int textKindIndex = DEFAULT_TEXT; + + // 当前选择的文字绘制样式索引，用于在textDrawable列表中定位对应的文字绘制相关配置，初始化为DEFAULT_BG，同样可通过设置方法更新来切换不同的文字背景和颜色组合等样式。 private int textDrawableIndex = DEFAULT_BG; + // 用于标识是否允许通过点击进行翻页操作，初始值为true，表示默认允许点击翻页，可通过设置方法改变其值，并将设置持久化存储，方便用户根据自己的阅读习惯进行调整。 private Boolean canClickTurn = true; + + // 用于标识是否允许通过按键（如音量键等，具体取决于应用的按键绑定设置）进行翻页操作，初始值为true，可通过设置方法修改值并保存设置，以满足不同用户对翻页操作方式的偏好。 private Boolean canKeyTurn = true; + // 用于存储应用的配置信息，通过SharedPreferences与应用的配置文件（通常以键值对形式存储数据）进行交互，实现阅读控制相关参数的持久化存储和读取。 private SharedPreferences preference; + // 静态变量，用于保存ReadBookControl类的唯一实例，遵循单例模式的设计，初始值为null，通过特定的获取实例方法来确保整个应用只有一个实例存在。 private static ReadBookControl readBookControl; - public static ReadBookControl getInstance(){ - if(readBookControl == null){ - synchronized (ReadBookControl.class){ - if(readBookControl == null){ + /** + * 静态方法，用于获取ReadBookControl类的唯一实例，实现了单例模式中的获取实例逻辑。 + * 首先判断readBookControl是否为null，如果是则进入同步代码块（使用synchronized关键字保证在多线程环境下只会有一个线程创建实例）， + * 在同步代码块内再次检查readBookControl是否为null，若仍为null则创建一个新的ReadBookControl实例并赋值给readBookControl，最后返回这个唯一的实例。 + * 这样可以保证无论在多少个地方调用这个方法，整个应用程序中始终只有一个ReadBookControl实例在运行，方便统一管理阅读控制相关参数。 + * @return 返回ReadBookControl类的唯一实例对象，通过该实例可以调用其他方法来获取和设置阅读相关的控制参数。 + */ + public static ReadBookControl getInstance() { + if (readBookControl == null) { + synchronized (ReadBookControl.class) { + if (readBookControl == null) { readBookControl = new ReadBookControl(); } } } return readBookControl; } - private ReadBookControl(){ - if(null == textKind){ + + /** + * 私有构造函数，用于创建ReadBookControl类的实例对象，在构造函数内部进行了一系列的初始化操作，包括初始化文字样式列表、文字绘制样式列表以及从SharedPreferences中读取之前保存的配置参数等， + * 确保实例创建时相关的阅读控制参数处于合适的初始状态，同时私有构造函数符合单例模式的设计要求，限制了外部直接创建实例的方式，只能通过getInstance方法获取实例。 + */ + private ReadBookControl() { + // 如果textKind列表为空（即还未初始化），则进行初始化操作，创建不同文字样式相关的配置信息并添加到textKind列表中。 + if (null == textKind) { textKind = new ArrayList<>(); - Map temp1 = new HashMap<>(); + // 创建一个临时的Map，用于存储一种文字样式的配置信息，这里设置文字大小为14（单位可能是像素等，具体看后续使用情况），文字间距通过DensityUtil工具类将dp值转换为像素值（6.5dp转换后的像素值），然后将这个配置信息添加到textKind列表中。 + Map temp1 = new HashMap<>(); temp1.put("textSize", 14); - temp1.put("textExtra", DensityUtil.dp2px(MApplication.getInstance(),6.5f)); + temp1.put("textExtra", DensityUtil.dp2px(MApplication.getInstance(), 6.5f)); textKind.add(temp1); - Map temp2 = new HashMap<>(); + // 类似地，创建另一种文字样式的配置信息，文字大小设置为16，文字间距通过DensityUtil转换对应dp值后的像素值，再添加到textKind列表中，方便后续根据索引选择不同的文字大小和间距配置。 + Map temp2 = new HashMap<>(); temp2.put("textSize", 16); - temp2.put("textExtra", DensityUtil.dp2px(MApplication.getInstance(),8)); + temp2.put("textExtra", DensityUtil.dp2px(MApplication.getInstance(), 8)); textKind.add(temp2); - Map temp3 = new HashMap<>(); + Map temp3 = new HashMap<>(); temp3.put("textSize", 17); - temp3.put("textExtra", DensityUtil.dp2px(MApplication.getInstance(),9)); + temp3.put("textExtra", DensityUtil.dp2px(MApplication.getInstance(), 9)); textKind.add(temp3); - Map temp4 = new HashMap<>(); + Map temp4 = new HashMap<>(); temp4.put("textSize", 20); - temp4.put("textExtra", DensityUtil.dp2px(MApplication.getInstance(),11)); + temp4.put("textExtra", DensityUtil.dp2px(MApplication.getInstance(), 11)); textKind.add(temp4); - Map temp5 = new HashMap<>(); + Map temp5 = new HashMap<>(); temp5.put("textSize", 22); - temp5.put("textExtra", DensityUtil.dp2px(MApplication.getInstance(),13)); + temp5.put("textExtra", DensityUtil.dp2px(MApplication.getInstance(), 13)); textKind.add(temp5); } - if(null == textDrawable){ + + // 如果textDrawable列表为空（未初始化），则进行初始化操作，创建不同文字绘制样式相关的配置信息（包含文字颜色和文字背景）并添加到textDrawable列表中。 + if (null == textDrawable) { textDrawable = new ArrayList<>(); - Map temp1 = new HashMap<>(); - temp1.put("textColor",Color.parseColor("#3E3D3B")); - temp1.put("textBackground",R.drawable.shape_bg_readbook_white); + // 创建一个临时的Map，用于存储一种文字绘制样式的配置信息，设置文字颜色通过Color.parseColor方法解析十六进制颜色代码（这里是深灰色）得到对应的颜色值，文字背景设置为指定的白色背景样式资源（通过R.drawable中的资源ID指定），然后将这个配置添加到textDrawable列表中。 + Map temp1 = new HashMap<>(); + temp1.put("textColor", Color.parseColor("#3E3D3B")); + temp1.put("textBackground", R.drawable.shape_bg_readbook_white); textDrawable.add(temp1); - Map temp2 = new HashMap<>(); - temp2.put("textColor",Color.parseColor("#5E432E")); - temp2.put("textBackground",R.drawable.bg_readbook_yellow); + Map temp2 = new HashMap<>(); + temp2.put("textColor", Color.parseColor("#5E432E")); + temp2.put("textBackground", R.drawable.bg_readbook_yellow); textDrawable.add(temp2); - Map temp3 = new HashMap<>(); - temp3.put("textColor",Color.parseColor("#22482C")); - temp3.put("textBackground",R.drawable.bg_readbook_green); + Map temp3 = new HashMap<>(); + temp3.put("textColor", Color.parseColor("#22482C")); + temp3.put("textBackground", R.drawable.bg_readbook_green); textDrawable.add(temp3); - Map temp4 = new HashMap<>(); - temp4.put("textColor",Color.parseColor("#808080")); - temp4.put("textBackground",R.drawable.bg_readbook_black); + Map temp4 = new HashMap<>(); + temp4.put("textColor", Color.parseColor("#808080")); + temp4.put("textBackground", R.drawable.bg_readbook_black); textDrawable.add(temp4); } + + // 获取应用的SharedPreferences对象，用于读取和保存阅读控制相关的配置参数，"CONFIG"是配置文件的名称，0表示操作模式（MODE_PRIVATE，即只有当前应用可以访问该文件）。 preference = MApplication.getInstance().getSharedPreferences("CONFIG", 0); - this.textKindIndex = preference.getInt("textKindIndex",DEFAULT_TEXT); + + // 从SharedPreferences中读取之前保存的文字样式索引值，如果不存在则使用默认的文字样式索引值（DEFAULT_TEXT），然后根据这个索引获取对应的文字大小和文字间距并赋值给相应变量。 + this.textKindIndex = preference.getInt("textKindIndex", DEFAULT_TEXT); this.textSize = textKind.get(textKindIndex).get("textSize"); this.textExtra = textKind.get(textKindIndex).get("textExtra"); - this.textDrawableIndex = preference.getInt("textDrawableIndex",DEFAULT_BG); + + // 从SharedPreferences中读取之前保存的文字绘制样式索引值，若不存在则用默认的背景样式索引值（DEFAULT_BG），再依据该索引获取对应的文字颜色和文字背景资源并赋值给相应变量。 + this.textDrawableIndex = preference.getInt("textDrawableIndex", DEFAULT_BG); this.textColor = textDrawable.get(textDrawableIndex).get("textColor"); this.textBackground = textDrawable.get(textDrawableIndex).get("textBackground"); - this.canClickTurn = preference.getBoolean("canClickTurn",true); - this.canKeyTurn = preference.getBoolean("canClickTurn",true); + // 从SharedPreferences中读取之前保存的是否允许点击翻页的配置值，如果不存在则使用默认值true，赋值给canClickTurn变量，用于确定当前是否允许点击翻页操作。 + this.canClickTurn = preference.getBoolean("canClickTurn", true); + + // 从SharedPreferences中读取之前保存的是否允许按键翻页的配置值，同样若不存在使用默认值true，赋值给canKeyTurn变量，用于判断当前是否允许按键翻页操作（这里代码可能存在重复设置canClickTurn的问题，应该是读取另一个键对应的布尔值，比如"canKeyTurn"对应的配置值，此处可能需要修正）。 + this.canKeyTurn = preference.getBoolean("canClickTurn", true); } + /** + * 获取当前的文字大小，外部代码可以调用此方法获取用于控制阅读界面文字显示大小的数值，方便根据实际情况进行展示或其他相关操作。 + * @return 当前设置的文字大小值，单位可能是像素等，具体取决于初始化和存储的设置情况。 + */ public int getTextSize() { return textSize; } + /** + * 获取当前的文字间距（额外间距），外部代码可通过调用此方法获取文字排版时的间距数值，用于调整文字展示的排版效果，使其更符合阅读习惯等需求。 + * @return 当前设置的文字间距值，单位可能是像素等，通过对应配置获取而来。 + */ public int getTextExtra() { return textExtra; } + /** + * 获取当前的文字颜色值，外部代码调用此方法可获取用于设置阅读界面文字显示颜色的数值，从而按照此颜色来渲染文字，使其呈现出特定的视觉效果。 + * @return 当前设置的文字颜色值，以Android系统的颜色表示方式存储（如ARGB等），通过配置获取得到。 + */ public int getTextColor() { return textColor; } + /** + * 获取当前的文字背景资源标识符，外部代码可利用此标识符来设置文字所在区域的背景样式，比如设置阅读界面文字背后的背景图片、颜色等样式，提升阅读的视觉感受。 + * @return 当前设置的文字背景资源的标识符（如R.drawable中的相关资源ID），通过配置获取而来，对应特定的背景样式资源。 + */ public int getTextBackground() { return textBackground; } + /** + * 获取当前选择的文字样式索引，外部代码可以通过这个索引值了解当前应用的是哪种文字样式配置，也可基于此索引进行一些相关的逻辑判断或操作（如展示当前文字样式名称等）。 + * @return 当前选择的文字样式索引值，对应textKind列表中的位置，用于定位具体的文字样式配置。 + */ public int getTextKindIndex() { return textKindIndex; } + /** + * 设置当前选择的文字样式索引，用于切换不同的文字样式，在设置新的索引值后，会将这个新值保存到SharedPreferences中实现持久化存储， + * 同时根据新的索引更新文字大小和文字间距等相关变量，确保配置的一致性，方便下次读取时能获取到最新的设置状态。 + * @param textKindIndex 要设置的文字样式索引值，需是合法的索引范围（对应textKind列表中的有效位置），用于指定新的文字样式配置。 + */ public void setTextKindIndex(int textKindIndex) { this.textKindIndex = textKindIndex; SharedPreferences.Editor editor = preference.edit(); - editor.putInt("textKindIndex",textKindIndex); + editor.putInt("textKindIndex", textKindIndex); editor.commit(); this.textSize = textKind.get(textKindIndex).get("textSize"); this.textExtra = textKind.get(textKindIndex).get("textExtra"); } + /** + * 获取当前选择的文字绘制样式索引，外部代码可通过此索引值知晓当前应用的文字颜色和文字背景的组合样式，也可用于相关的展示或逻辑判断操作。 + * @return 当前选择的文字绘制样式索引值，对应textDrawable列表中的位置，用于定位具体的文字绘制相关配置。 + */ public int getTextDrawableIndex() { return textDrawableIndex; } + /** + * 设置当前选择的文字绘制样式索引，用于切换不同的文字颜色和文字背景组合样式，在设置新的索引值后，会将其保存到SharedPreferences中持久化存储， + * 同时根据新索引更新文字颜色和文字背景等相关变量，保证配置的一致性，以便后续能按照新设置进行文字绘制相关的展示操作。 + * @param textDrawableIndex 要设置的文字绘制样式索引值，需是合法的索引范围（对应textDrawable列表中的有效位置），用于指定新的文字绘制相关配置。 + */ public void setTextDrawableIndex(int textDrawableIndex) { this.textDrawableIndex = textDrawableIndex; SharedPreferences.Editor editor = preference.edit(); - editor.putInt("textDrawableIndex",textDrawableIndex); + editor.putInt("textDrawableIndex", textDrawableIndex); editor.commit(); this.textColor = textDrawable.get(textDrawableIndex).get("textColor"); this.textBackground = textDrawable.get(textDrawableIndex).get("textBackground"); } + /** + * 获取存储文字样式相关配置信息的列表，外部代码可以通过这个列表获取所有已定义的文字样式配置内容（如文字大小、文字间距等信息）， + * 例如可以用于展示给用户选择不同文字样式的界面中，展示所有可选择的文字样式详情。 + * @return 存储文字样式相关配置信息的列表，每个元素是一个Map，包含文字大小、文字间距等具体配置项。 + */ public static List> getTextKind() { return textKind; } + /** + * 获取存储文字绘制相关配置信息的列表，外部代码可利用此列表获取所有已定义的文字绘制相关配置内容（如不同的文字颜色和文字背景组合等信息）， + * 例如用于在界面上展示不同文字绘制样式供用户选择，方便用户个性化阅读界面的视觉效果。 + * @return 存储文字绘制相关配置信息的列表，每个元素是一个Map，包含文字颜色、文字背景等具体配置项。 + */ public static List> getTextDrawable() { return textDrawable; } + /** + * 获取是否允许通过按键进行翻页操作的标识，外部代码可以根据这个标识来决定是否启用按键翻页相关的功能逻辑（如监听按键事件进行翻页等操作），满足用户不同的操作习惯需求。 + * @return 布尔值，true表示允许按键翻页，false表示禁止按键翻页。 + */ public Boolean getCanKeyTurn() { return canKeyTurn; } - public void setCanKeyTurn(Boolean canKeyTurn) { - this.canKeyTurn = canKeyTurn; - SharedPreferences.Editor editor = preference.edit(); - editor.putBoolean("canKeyTurn",canKeyTurn); - editor.commit(); - } - - public Boolean getCanClickTurn() { - return canClickTurn; - } - - public void setCanClickTurn(Boolean canClickTurn) { - this.canClickTurn = canClickTurn; - SharedPreferences.Editor editor = preference.edit(); - editor.putBoolean("canClickTurn",canClickTurn); - editor.commit(); - } -} \ No newline at end of file +/** + * 设置是否允许通过按键进行翻页操作，将传入的布尔值保存到SharedPreferences中实现持久化存储，用于根据用户需求改变按键翻页的可用性， + * 同时更新 \ No newline at end of file