添加注释

src/Notes-master/src/net/micode/notes/data/Contact.java

@@ -13,18 +13,32 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
+// 声明该Java类所属的包为net.micode.notes.data，此包通常用于存放与笔记应用数据相关的代码
 package net.micode.notes.data;
 
 import android.content.Context;
+// 导入android.content.Context类，它是Android应用程序环境的全局信息接口，
+// 用于访问应用程序的资源、启动组件等操作，在后续代码中可能用于获取系统服务、访问数据库等
 import android.database.Cursor;
+// 导入android.database.Cursor类，它用于遍历查询结果集，在从数据库查询联系人信息时会用到
 import android.provider.ContactsContract.CommonDataKinds.Phone;
+// 导入android.provider.ContactsContract.CommonDataKinds.Phone类，
+// 该类定义了联系人数据库中电话相关数据的常量，如电话号码、联系人显示名称等，用于查询联系人电话信息
 import android.provider.ContactsContract.Data;
+// 导入android.provider.ContactsContract.Data类，它是联系人数据库中数据的通用表示，
+// 包含了各种类型的数据（如电话、邮件等）的元数据，在查询联系人数据时会涉及到
 import android.telephony.PhoneNumberUtils;
+// 导入android.telephony.PhoneNumberUtils类，它提供了处理电话号码的实用方法，
+// 在后续代码中可能用于格式化电话号码、验证电话号码等操作
 import android.util.Log;
+// 导入android.util.Log类，用于记录应用程序的日志信息，方便调试和排查问题，在代码中用于记录错误或调试信息
 
 import java.util.HashMap;
+// 导入java.util.HashMap类，它是一个基于哈希表的Map接口实现，
+// 用于存储键值对数据，在需要无序存储和快速查找数据时会用到
 import java.util.LinkedHashMap;
+// 导入java.util.LinkedHashMap类，它继承自HashMap，
+// 并维护插入顺序或访问顺序，在代码中用于实现联系人缓存，以便按插入顺序清理较旧的缓存项
 import java.util.Map;
 
 import android.content.ContentResolver;
@@ -41,14 +55,15 @@ import java.util.Map;
 public class Contact {
     // 定义最大缓存数量，可根据实际情况调整，这里假设最多缓存100个联系人信息
     private static final int MAX_CACHE_SIZE = 100;
-    // 使用LinkedHashMap来实现缓存，它能保持插入顺序，方便后续按顺序清理较旧的缓存项
+    // 使用LinkedHashMap来实现缓存，它能维持元素的插入顺序，便于后续按顺序清理较旧的缓存项
     private static LinkedHashMap<String, String> sContactCache;
+    // 用于日志记录的标签
     private static final String TAG = "Contact";
 
-    // 定义用于查询联系人的SQL选择语句，通过电话号码在联系人数据库中查找匹配的联系人
-    private static final String CALLER_ID_SELECTION = "PHONE_NUMBERS_EQUAL(" + ContactsContract.CommonDataKinds.Phone.NUMBER
-            + ",?) AND " + ContactsContract.Data.MIMETYPE + "='" + ContactsContract.CommonDataKinds.Phone.CONTENT_ITEM_TYPE + "'"
-            + " AND " + ContactsContract.Data.RAW_CONTACT_ID + " IN "
+    // 定义用于查询联系人的SQL选择语句，此语句用于从联系人数据库中通过电话号码查找对应的联系人
+    private static final String CALLER_ID_SELECTION = "PHONE_NUMBERS_EQUAL(" + Phone.NUMBER
+            + ",?) AND " + Data.MIMETYPE + "='" + Phone.CONTENT_ITEM_TYPE + "'"
+            + " AND " + Data.RAW_CONTACT_ID + " IN "
             + "(SELECT raw_contact_id "
             + " FROM phone_lookup"
             + " WHERE min_match = '+')";
@@ -56,55 +71,57 @@ public class Contact {
     /**
      * 根据给定的电话号码获取对应的联系人姓名
      *
-     * @param context     Android应用上下文，用于访问系统资源，如联系人数据库
+     * @param context     Android应用上下文，借助它可以访问系统资源，比如联系人数据库
      * @param phoneNumber 要查询对应联系人姓名的电话号码
-     * @return 如果找到对应的联系人，则返回联系人姓名，否则返回null
+     * @return 如果找到对应的联系人，则返回联系人姓名；若未找到，则返回null
      */
     public static String getContact(Context context, String phoneNumber) {
-        // 初始化缓存，如果缓存还未创建，则创建一个新的LinkedHashMap实例
+        // 初始化缓存，若缓存尚未创建，则创建一个新的LinkedHashMap实例
         if (sContactCache == null) {
             sContactCache = new LinkedHashMap<String, String>() {
-                // 重写removeEldestEntry方法，用于定义在何种情况下移除最老的缓存项
+                // 重写removeEldestEntry方法，以此定义在何种情形下移除最老的缓存项
                 @Override
                 protected boolean removeEldestEntry(Map.Entry<String, String> eldest) {
-                    // 当缓存的数量大于等于最大缓存数量时，返回true，表示需要移除最老的缓存项
+                    // 当缓存中的元素数量大于或等于最大缓存数量时，返回true，意味着需要移除最老的缓存项
                     return size() >= MAX_CACHE_SIZE;
                 }
             };
         }
 
-        // 先检查缓存中是否已经存在该电话号码对应的联系人姓名
+        // 首先检查缓存中是否已存在该电话号码对应的联系人姓名
         if (sContactCache.containsKey(phoneNumber)) {
             return sContactCache.get(phoneNumber);
         }
 
-        // 根据传入的电话号码构建查询条件，替换特定的占位符等
+        // 根据传入的电话号码构建查询条件，对特定的占位符进行替换等操作
         String selection = CALLER_ID_SELECTION.replace("+",
                 PhoneNumberUtils.toCallerIDMinMatch(phoneNumber));
-        ContentResolver contentResolver = context.getContentResolver();
-        Cursor cursor = contentResolver.query(
-                ContactsContract.Data.CONTENT_URI,
-                new String[]{ContactsContract.CommonDataKinds.Phone.DISPLAY_NAME},
+        // 通过应用上下文的内容解析器进行数据库查询
+        Cursor cursor = context.getContentResolver().query(
+                Data.CONTENT_URI,
+                // 定义查询结果返回的列，这里只返回联系人的显示名称
+                new String[]{Phone.DISPLAY_NAME},
                 selection,
                 new String[]{phoneNumber},
                 null);
 
         if (cursor!= null && cursor.moveToFirst()) {
             try {
+                // 从游标中获取联系人姓名
                 String name = cursor.getString(0);
                 // 将查询到的联系人姓名存入缓存
                 sContactCache.put(phoneNumber, name);
                 return name;
             } catch (IndexOutOfBoundsException e) {
-                // 如果在获取游标数据时出现越界等异常，记录错误日志
+                // 若在获取游标数据时发生越界等异常，记录错误日志
                 Log.e(TAG, " Cursor get string error " + e.toString());
                 return null;
             } finally {
-                // 无论是否出现异常，都要关闭游标，释放资源
+                // 无论是否出现异常，都要关闭游标以释放资源
                 cursor.close();
             }
         } else {
-            // 如果没有查询到对应的联系人，记录一条调试日志
+            // 如果未查询到对应的联系人，记录一条调试日志
             Log.d(TAG, "No contact matched with number:" + phoneNumber);
             return null;
         }