diff --git a/doc/report.docx b/doc/report.docx index 932d445..16fb34e 100644 Binary files a/doc/report.docx and b/doc/report.docx differ diff --git a/src/main/java/net/micode/notes/data/Contact.java b/src/main/java/net/micode/notes/data/Contact.java index 1e04184..b42deca 100644 --- a/src/main/java/net/micode/notes/data/Contact.java +++ b/src/main/java/net/micode/notes/data/Contact.java @@ -22,42 +22,57 @@ import android.provider.ContactsContract.CommonDataKinds.Phone; import android.provider.ContactsContract.Data; import android.telephony.PhoneNumberUtils; import android.util.Log; - import java.util.HashMap; -public class Contact {//定义一个Contact类，类别标签为Contact，包含一个用于存储用户信息的HashMap - private static HashMap sContactCache; - private static final String TAG = "Contact"; -//定义静态常量，用于查询指定联系人 - 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 " +// 该代码是一个名为Contact的类，用于获取联系人信息。 +//代码中定义了一个静态的HashMap变量sContactCache，用于缓存联系人信息。sContactCache的键是电话号码，值是联系人姓名。 +//定义了一个字符串常量CALLER_ID_SELECTION，用于查询联系人信息的条件。该条件是通过拼接字符串而得到的，包含了查询电话号码相等、数据类型为电话号码、联系人ID在指定范围内等条件。 +//代码中定义了一个静态方法getContact，用于根据电话号码获取联系人姓名。 +public class Contact { + private static HashMap sContactCache; // 缓存联系人信息 + private static final String TAG = "Contact";//标签 + 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 = '+')"; -//定义一个静态方法getContact，可以通过Contact对象以及电话号码查询联系人。 + + " WHERE min_match = '+')"; // 查询联系人信息的条件 + + /** + * 根据电话号码获取联系人姓名 + * @param context 上下文对象 + * @param phoneNumber 电话号码 + * @return 联系人姓名，如果未找到则返回null + */ +// 该方法首先检查缓存中是否已有该电话号码对应的联系人姓名，如果有则返回缓存中的值。如果缓存中没有该电话号码对应的联系人姓名，则通过查询数据库来获取联系人姓名。 +// 查询数据库的条件是根据电话号码生成的CALLER_ID_SELECTION。如果查询结果不为空且移动到第一条记录，则从结果中提取联系人姓名，并将其存入缓存中。如果查询结果为空，则返回null。 public static String getContact(Context context, String phoneNumber) { - if(sContactCache == null) {//不存在这个联系人则新建一个存储信息 + if (sContactCache == null) { sContactCache = new HashMap(); } - if(sContactCache.containsKey(phoneNumber)) {//如果已经包含电话号码作为关键字对应的用户 - return sContactCache.get(phoneNumber);//直接返回用户的名字，get返回名字 + // 查找HashMap中是否已有phoneNumber信息 + if (sContactCache.containsKey(phoneNumber)) { + return sContactCache.get(phoneNumber);//直接根据键值（电话号码）找到姓名 } String selection = CALLER_ID_SELECTION.replace("+", - PhoneNumberUtils.toCallerIDMinMatch(phoneNumber)); + PhoneNumberUtils.toCallerIDMinMatch(phoneNumber));//最小匹配原则查找电话号码 + + // 查找数据库中phoneNumber的信息 Cursor cursor = context.getContentResolver().query( Data.CONTENT_URI, - new String [] { Phone.DISPLAY_NAME }, + 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); + sContactCache.put(phoneNumber, name);//放入缓存块 return name; } catch (IndexOutOfBoundsException e) { Log.e(TAG, " Cursor get string error " + e.toString()); @@ -66,7 +81,8 @@ public class Contact {//定义一个Contact类，类别标签为Contact，包含 cursor.close(); } } else { - Log.d(TAG, "No contact matched with number:" + phoneNumber); + // 未找到相关信息 + Log.d(TAG, "No contact matched with number:" + phoneNumber);//给出反馈信息 return null; } } diff --git a/src/main/java/net/micode/notes/gtask/exception/ActionFailureException.java b/src/main/java/net/micode/notes/gtask/exception/ActionFailureException.java index 83424dc..1909174 100644 --- a/src/main/java/net/micode/notes/gtask/exception/ActionFailureException.java +++ b/src/main/java/net/micode/notes/gtask/exception/ActionFailureException.java @@ -15,19 +15,28 @@ */ package net.micode.notes.gtask.exception; +/** + * @method: ActionFailureException + * @description:ActionFailureException 继承了 RuntimeException 类，用于扩展抛错机制，显示具体错误类型 + * 这个类采取直接执行父类构造方法来完成类的构造，总计完成了有参数以及无参数情况下的三种构造方法 + * 定义了私有参数serialVersionUID，是序列化，用于验证版本一致性 + * @date: 11:05 + * @author: Xia Yanbo +*/ -public class ActionFailureException extends RuntimeException {//异常处理程序，定义了全部可能参数下抛出错误 - private static final long serialVersionUID = 4425249765923293627L; - +public class ActionFailureException extends RuntimeException { + private static final long serialVersionUID = 4425249765923293627L;//序列化，用于验证版本一致性 + //构造方法 public ActionFailureException() { - super(); + super();//用构造方法赋初值，调用父类无参数的构造方法 } - + //构造方法 public ActionFailureException(String paramString) { - super(paramString); + super(paramString);//调用父类有参数的构造方法 } - + //构造方法 public ActionFailureException(String paramString, Throwable paramThrowable) { super(paramString, paramThrowable); } } + diff --git a/src/main/java/net/micode/notes/gtask/exception/NetworkFailureException.java b/src/main/java/net/micode/notes/gtask/exception/NetworkFailureException.java index 66d6749..331588d 100644 --- a/src/main/java/net/micode/notes/gtask/exception/NetworkFailureException.java +++ b/src/main/java/net/micode/notes/gtask/exception/NetworkFailureException.java @@ -15,18 +15,29 @@ */ package net.micode.notes.gtask.exception;//调用完成异常处理 +/** + * @method: NetworkFailureException + * @description:NetworkFailureException 继承了 Exception 类，用于扩展抛错机制，显示具体错误类型 + * 这个类采取直接执行父类构造方法来完成类的构造，总计完成了有参数以及无参数情况下的三种构造方法 + * //定义了私有参数serialVersionUID，是序列化，用于验证版本一致性 + * @date: 11:07 + * @author: Xia Yanbo + * @param: + * @param: + * @param: +*/ public class NetworkFailureException extends Exception { - private static final long serialVersionUID = 2107610287180234136L; - + private static final long serialVersionUID = 2107610287180234136L;//序列化，用于验证版本一致性 + //构造方法 public NetworkFailureException() { - super(); + super();//用构造方法赋初值，调用父类无参数的构造方法 } - + //构造方法 public NetworkFailureException(String paramString) { - super(paramString); + super(paramString);//调用父类有参数的构造方法 } - + //构造方法 public NetworkFailureException(String paramString, Throwable paramThrowable) { super(paramString, paramThrowable); }