Android應用添加日歷提醒功能

功能

在安卓應用里調用系統日歷，直接創建一個帶提醒的日歷事件，甚至不需要跳轉到日歷界面，只需要獲取系統日歷的讀取權限即可。

需要的權限

在AndroidManifest.xml里添加

<uses-permission android:name="android.permission.READ_CALENDAR"/>
<uses-permission android:name="android.permission.WRITE_CALENDAR"/>

注意：如果是Android 6.0（API 23）以上，需要動態申請權限。

代碼

創建一個CalendarHelper工具類，包含：

獲取系統日歷賬戶
自動寫入事件
添加提醒
自動處理沒有日歷賬戶的情況（可提示用戶手動創建）
動態申請權限(當用戶拒絕權限時，我這里會彈出一個提示框，提示的內容可以從外部傳入，也可以使用默認的。或者你不是使用默認，直接打開系統的設置頁面也是可以的(下面屏蔽了這部分的代碼))
判斷是否已存在相同時間的邏輯，避免重復添加

package com.cocos.calender;import android.app.Activity;
import android.Manifest;
import android.content.ContentUris;
import android.content.ContentValues;
import android.content.Context;
import android.content.Intent;
import android.content.pm.PackageManager;
import android.database.Cursor;
import android.net.Uri;
import android.provider.CalendarContract;
import android.provider.Settings;
import android.text.TextUtils;
import android.util.Log;import androidx.annotation.NonNull;
import androidx.core.app.ActivityCompat;
import androidx.core.content.ContextCompat;import java.util.Calendar;
import java.util.TimeZone;
import org.json.JSONObject;
import org.json.JSONException;
import android.widget.Toast;public class CalendarHelper {private static final String TAG = "CalendarHelper";/** 用來存放拒絕權限時的提示語 */private static String denyPermissionMessage = "未獲得日歷權限，無法添加提醒事件";/** 日歷權限請求碼 */public static final int REQUEST_CALENDAR_PERMISSION = 1010;/** 臨時存儲待執行事件 */private static PendingEvent pendingEvent;private static class PendingEvent {String title;String description;String location;long beginTime;long endTime;int reminderMinutes;PendingEvent(String title, String description, String location,long beginTime, long endTime, int reminderMinutes) {this.title = title;this.description = description;this.location = location;this.beginTime = beginTime;this.endTime = endTime;this.reminderMinutes = reminderMinutes;}}/*** 檢查權限并添加事件（帶權限請求）*/public static void addEventWithPermission(Activity activity,String title,String description,String location,long beginTimeMillis,long endTimeMillis,int reminderMinutes) {// 檢查日歷讀寫權限if (ContextCompat.checkSelfPermission(activity, Manifest.permission.WRITE_CALENDAR)!= PackageManager.PERMISSION_GRANTED|| ContextCompat.checkSelfPermission(activity, Manifest.permission.READ_CALENDAR)!= PackageManager.PERMISSION_GRANTED) {// 保存事件等待用戶授權pendingEvent = new PendingEvent(title, description, location, beginTimeMillis, endTimeMillis, reminderMinutes);// 這里可以加解釋，但不強制if (ActivityCompat.shouldShowRequestPermissionRationale(activity, Manifest.permission.READ_CALENDAR)) {Log.i(TAG, "需要日歷權限來添加提醒事件");}// ? 直接請求權限（即使用戶上次拒絕，這里依舊會再彈一次）ActivityCompat.requestPermissions(activity,new String[]{Manifest.permission.READ_CALENDAR,Manifest.permission.WRITE_CALENDAR},REQUEST_CALENDAR_PERMISSION);} else {// 權限已授權，直接添加addEvent(activity, title, description, location, beginTimeMillis, endTimeMillis, reminderMinutes);}}/*** 在 Activity 的 onRequestPermissionsResult 中調用*/public static void onRequestPermissionsResultCalendar(Activity activity,int requestCode,@NonNull int[] grantResults) {if (requestCode == REQUEST_CALENDAR_PERMISSION) {if (grantResults.length >= 2&& grantResults[0] == PackageManager.PERMISSION_GRANTED&& grantResults[1] == PackageManager.PERMISSION_GRANTED) {Log.i(TAG, "日歷權限申請成功");if (pendingEvent != null) {addEvent(activity,pendingEvent.title,pendingEvent.description,pendingEvent.location,pendingEvent.beginTime,pendingEvent.endTime,pendingEvent.reminderMinutes);pendingEvent = null;}} else {Log.e(TAG, "用戶拒絕了日歷權限");Toast.makeText(activity,denyPermissionMessage,Toast.LENGTH_SHORT).show();// 如果用戶永久拒絕，可跳轉設置
//                if (!ActivityCompat.shouldShowRequestPermissionRationale(activity, android.Manifest.permission.READ_CALENDAR)) {
//                    Intent intent = new Intent(Settings.ACTION_APPLICATION_DETAILS_SETTINGS);
//                    intent.setData(Uri.parse("package:" + activity.getPackageName()));
//                    activity.startActivity(intent);
//                }}}}/** 獲取系統日歷賬戶 ID */private static long getCalendarAccountId(Context context) {Cursor userCursor = context.getContentResolver().query(CalendarContract.Calendars.CONTENT_URI,new String[]{CalendarContract.Calendars._ID},null, null, null);if (userCursor != null) {try {if (userCursor.moveToFirst()) {return userCursor.getLong(0);}} finally {userCursor.close();}}return -1;}/** 判斷事件是否已存在（避免重復） */private static boolean isEventAlreadyExists(Context context, String title, long beginTimeMillis) {long oneMinuteBefore = beginTimeMillis - 60 * 1000;long oneMinuteAfter = beginTimeMillis + 60 * 1000;Cursor cursor = context.getContentResolver().query(CalendarContract.Events.CONTENT_URI,new String[]{CalendarContract.Events._ID},CalendarContract.Events.TITLE + "=? AND " +CalendarContract.Events.DTSTART + ">=? AND " +CalendarContract.Events.DTSTART + "<=?",new String[]{title, String.valueOf(oneMinuteBefore), String.valueOf(oneMinuteAfter)},null);if (cursor != null) {try {if (cursor.moveToFirst()) {return true; // 已存在}} finally {cursor.close();}}return false;}/** 插入日歷事件 + 提醒 */private static boolean addEvent(Context context,String title,String description,String location,long beginTimeMillis,long endTimeMillis,int reminderMinutes) {long calId = getCalendarAccountId(context);if (calId == -1) {Log.e(TAG, "沒有找到系統日歷賬戶，請先在系統日歷中添加一個賬戶");return false;}if (isEventAlreadyExists(context, title, beginTimeMillis)) {Log.w(TAG, "事件已存在，跳過添加: " + title);return false;}ContentValues eventValues = new ContentValues();eventValues.put(CalendarContract.Events.CALENDAR_ID, calId);eventValues.put(CalendarContract.Events.TITLE, TextUtils.isEmpty(title) ? "未命名事件" : title);eventValues.put(CalendarContract.Events.DESCRIPTION, description);eventValues.put(CalendarContract.Events.EVENT_LOCATION, location);eventValues.put(CalendarContract.Events.DTSTART, beginTimeMillis);eventValues.put(CalendarContract.Events.DTEND, endTimeMillis);eventValues.put(CalendarContract.Events.HAS_ALARM, 1);eventValues.put(CalendarContract.Events.EVENT_TIMEZONE, TimeZone.getDefault().getID());Uri newEvent = context.getContentResolver().insert(CalendarContract.Events.CONTENT_URI, eventValues);if (newEvent == null) {Log.e(TAG, "插入日歷事件失敗");return false;}long eventId = ContentUris.parseId(newEvent);ContentValues reminderValues = new ContentValues();reminderValues.put(CalendarContract.Reminders.EVENT_ID, eventId);reminderValues.put(CalendarContract.Reminders.MINUTES, reminderMinutes);reminderValues.put(CalendarContract.Reminders.METHOD, CalendarContract.Reminders.METHOD_ALERT);Uri reminderUri = context.getContentResolver().insert(CalendarContract.Reminders.CONTENT_URI, reminderValues);if (reminderUri == null) {Log.e(TAG, "插入提醒失敗");return false;}Log.i(TAG, "日歷事件添加成功，eventId=" + eventId);return true;}public static void creatroCalendarReminder(Context context,String data){try {// 將傳入的字符串轉成 JSON 對象JSONObject json = new JSONObject(data);// 從 JSON 中取字段，如果沒有就用默認值String title = json.optString("title", "測試");String description = json.optString("description", "測試");String location = json.optString("location", "測試");int startHour = json.optInt("startHour", 1);int startMinute = json.optInt("startMinute", 10);int endHour = json.optInt("endHour", startHour + 1);Calendar begin = Calendar.getInstance();begin.add(Calendar.DAY_OF_MONTH, 0);         // 哪天開始，Calendar.DAY_OF_MONTH當前時間 + 后面參數值，比如我這里為0，就是今天，如果為1就是明天begin.set(Calendar.HOUR_OF_DAY, startHour);  // 開始的小時，這里是24小時制 startHour的取值范圍為0~23begin.set(Calendar.MINUTE, startMinute);     // 開始的分鐘 Calendar end = (Calendar) begin.clone();end.set(Calendar.HOUR_OF_DAY, endHour);      // 結束的時間，參數和上面開始時間一樣，賦值方式為end.set（）if (context == null) {Log.e("Calendar", "Context is null");return;}// 添加事件CalendarHelper.addEventWithPermission((Activity) context,title,description,location,begin.getTimeInMillis(),   //事件開始時間的毫秒值end.getTimeInMillis(),     //事件結束時間的毫秒值5   // 提前5分鐘提醒);} catch (JSONException e) {e.printStackTrace();Log.e("Calendar", "JSON解析失敗：" + data);}}/*** 從外部傳提示文本過來* @param message*/public static void setDenyPermissionMessage(String message) {if (!TextUtils.isEmpty(message)) {denyPermissionMessage = message;}}
}

Activity中的邏輯

先在Activity中引入CalendarHelper類，并調用CalendarHelper.creatroCalendarReminder()方法，傳入參數，實現日歷添加功能。

    @Overridepublic void onRequestPermissionsResult(int requestCode, String[] permissions, int[] grantResults) {super.onRequestPermissionsResult(requestCode, permissions, grantResults);// 處理日歷權限if (requestCode == CalendarHelper.REQUEST_CALENDAR_PERMISSION) {if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {CalendarHelper.onRequestPermissionsResultCalendar(this, requestCode, grantResults);}}}

添加創建日歷提醒事件和傳入提示文本

    /*** 創建日歷提醒事件* @param data*/public static void creatroCalendarReminder(String data){Context context = AppActivity.getInstance();CalendarHelper.creatroCalendarReminder(context,data);}/*** 獲取讀取日歷權限被拒絕時的提示文本* @param str*/public static void setDenyPermissionMessage(String str){CalendarHelper.setDenyPermissionMessage(str);}