[file name]: BackupUtils.java
[file content begin]
/*
 * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net)
 * 版权声明：2010-2011年，MiCode开源社区
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * 基于Apache License 2.0许可证授权
 * you may not use this file except in compliance with the License.
 * 除非遵守许可证，否则不得使用此文件
 * You may obtain a copy of the License at
 * 可以在以下地址获取许可证副本
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * 除非适用法律要求或书面同意
 * distributed under the License is distributed on an "AS IS" BASIS,
 * 按"原样"分发软件
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * 没有任何明示或暗示的担保或条件
 * See the License for the specific language governing permissions and
 * 请参阅许可证了解具体语言权限
 * limitations under the License.
 * 和限制
 */

// 包声明：工具类包
package net.micode.notes.tool;

// 导入Android相关类
import android.content.Context;           // 上下文类，用于访问应用资源
import android.database.Cursor;           // 数据库游标，用于查询结果
import android.os.Environment;            // 环境类，用于访问外部存储
import android.text.TextUtils;            // 文本工具类
import android.text.format.DateFormat;    // 日期格式化类
import android.util.Log;                  // 日志工具类

// 导入应用内部资源
import net.micode.notes.R;                // R资源文件
import net.micode.notes.data.Notes;       // 笔记数据类
import net.micode.notes.data.Notes.DataColumns;      // 数据列定义
import net.micode.notes.data.Notes.DataConstants;    // 数据常量定义
import net.micode.notes.data.Notes.NoteColumns;      // 笔记列定义

// 导入Java IO类
import java.io.File;                      // 文件类
import java.io.FileNotFoundException;     // 文件未找到异常
import java.io.FileOutputStream;          // 文件输出流
import java.io.IOException;               // IO异常
import java.io.PrintStream;               // 打印流

// 备份工具类：负责将笔记数据导出为文本文件
public class BackupUtils {
    private static final String TAG = "BackupUtils"; // 日志标签
    // 单例模式相关
    private static BackupUtils sInstance; // 静态单例实例

    // 获取单例实例的静态方法，使用synchronized确保线程安全
    public static synchronized BackupUtils getInstance(Context context) {
        if (sInstance == null) {          // 如果实例为空
            sInstance = new BackupUtils(context); // 创建新实例
        }
        return sInstance;                  // 返回实例
    }

    /**
     * 以下是表示备份或恢复状态的常量
     */
    // 状态常量定义
    public static final int STATE_SD_CARD_UNMOUONTED           = 0; // SD卡未挂载状态
    public static final int STATE_BACKUP_FILE_NOT_EXIST        = 1; // 备份文件不存在状态
    public static final int STATE_DATA_DESTROIED               = 2; // 数据被破坏状态
    public static final int STATE_SYSTEM_ERROR                 = 3; // 系统错误状态
    public static final int STATE_SUCCESS                      = 4; // 成功状态

    private TextExport mTextExport;        // 文本导出器实例

    // 私有构造函数，外部不能直接实例化
    private BackupUtils(Context context) {
        mTextExport = new TextExport(context); // 创建文本导出器
    }

    // 检查外部存储是否可用的静态方法
    private static boolean externalStorageAvailable() {
        // 判断外部存储状态是否为已挂载
        return Environment.MEDIA_MOUNTED.equals(Environment.getExternalStorageState());
    }

    // 导出数据到文本文件的公共方法
    public int exportToText() {
        return mTextExport.exportToText(); // 调用文本导出器的导出方法
    }

    // 获取导出的文本文件名
    public String getExportedTextFileName() {
        return mTextExport.mFileName;      // 返回文件名
    }

    // 获取导出的文本文件目录
    public String getExportedTextFileDir() {
        return mTextExport.mFileDirectory; // 返回文件目录
    }

    // 内部类：文本导出器，实现具体的导出逻辑
    private static class TextExport {
        // 笔记表查询字段数组，定义需要查询的列
        private static final String[] NOTE_PROJECTION = {
                NoteColumns.ID,            // 笔记ID列
                NoteColumns.MODIFIED_DATE, // 修改日期列
                NoteColumns.SNIPPET,       // 内容摘要列
                NoteColumns.TYPE           // 类型列
        };

        // 笔记列索引常量
        private static final int NOTE_COLUMN_ID = 0;              // ID列索引
        private static final int NOTE_COLUMN_MODIFIED_DATE = 1;   // 修改日期列索引
        private static final int NOTE_COLUMN_SNIPPET = 2;         // 内容摘要列索引

        // 数据表查询字段数组
        private static final String[] DATA_PROJECTION = {
                DataColumns.CONTENT,       // 内容列
                DataColumns.MIME_TYPE,     // MIME类型列
                DataColumns.DATA1,         // 数据1列
                DataColumns.DATA2,         // 数据2列
                DataColumns.DATA3,         // 数据3列
                DataColumns.DATA4,         // 数据4列
        };

        // 数据列索引常量
        private static final int DATA_COLUMN_CONTENT = 0;         // 内容列索引
        private static final int DATA_COLUMN_MIME_TYPE = 1;       // MIME类型列索引
        private static final int DATA_COLUMN_CALL_DATE = 2;       // 通话日期列索引
        private static final int DATA_COLUMN_PHONE_NUMBER = 4;    // 电话号码列索引

        // 文本格式化字符串数组，从资源文件中读取
        private final String [] TEXT_FORMAT;
        // 格式化索引常量
        private static final int FORMAT_FOLDER_NAME          = 0; // 文件夹名称格式索引
        private static final int FORMAT_NOTE_DATE            = 1; // 笔记日期格式索引
        private static final int FORMAT_NOTE_CONTENT         = 2; // 笔记内容格式索引

        private Context mContext;          // 上下文对象
        private String mFileName;          // 文件名
        private String mFileDirectory;     // 文件目录

        // 构造函数
        public TextExport(Context context) {
            // 从资源文件获取文本格式化数组
            TEXT_FORMAT = context.getResources().getStringArray(R.array.format_for_exported_note);
            mContext = context;            // 保存上下文
            mFileName = "";                // 初始化文件名为空
            mFileDirectory = "";           // 初始化文件目录为空
        }

        // 获取指定索引的格式化字符串
        private String getFormat(int id) {
            return TEXT_FORMAT[id];        // 返回格式化字符串
        }

        /**
         * 导出指定文件夹的笔记到文本
         * @param folderId 文件夹ID
         * @param ps 打印流，用于输出文本
         */
        private void exportFolderToText(String folderId, PrintStream ps) {
            // 查询属于该文件夹的笔记
            Cursor notesCursor = mContext.getContentResolver().query(Notes.CONTENT_NOTE_URI,
                    NOTE_PROJECTION,           // 查询的列
                    NoteColumns.PARENT_ID + "=?", // 查询条件：父ID等于指定文件夹ID
                    new String[] { folderId }, // 查询参数
                    null);                     // 排序方式（无）

            if (notesCursor != null) {         // 如果游标不为空
                if (notesCursor.moveToFirst()) { // 如果游标移动到第一行
                    do {
                        // 打印笔记的最后修改日期
                        ps.println(String.format(getFormat(FORMAT_NOTE_DATE), DateFormat.format(
                                mContext.getString(R.string.format_datetime_mdhm), // 日期时间格式
                                notesCursor.getLong(NOTE_COLUMN_MODIFIED_DATE)))); // 修改日期
                        // 查询属于该笔记的数据
                        String noteId = notesCursor.getString(NOTE_COLUMN_ID); // 获取笔记ID
                        exportNoteToText(noteId, ps); // 导出该笔记的内容
                    } while (notesCursor.moveToNext()); // 移动到下一行
                }
                notesCursor.close();           // 关闭游标
            }
        }

        /**
         * 导出指定笔记到打印流
         * @param noteId 笔记ID
         * @param ps 打印流，用于输出文本
         */
        private void exportNoteToText(String noteId, PrintStream ps) {
            // 查询属于该笔记的数据
            Cursor dataCursor = mContext.getContentResolver().query(Notes.CONTENT_DATA_URI,
                    DATA_PROJECTION,           // 查询的列
                    DataColumns.NOTE_ID + "=?", // 查询条件：笔记ID等于指定笔记ID
                    new String[] { noteId },   // 查询参数
                    null);                     // 排序方式（无）

            if (dataCursor != null) {          // 如果游标不为空
                if (dataCursor.moveToFirst()) { // 如果游标移动到第一行
                    do {
                        // 获取MIME类型
                        String mimeType = dataCursor.getString(DATA_COLUMN_MIME_TYPE);
                        if (DataConstants.CALL_NOTE.equals(mimeType)) { // 如果是通话笔记类型
                            // 获取通话笔记的各个字段
                            String phoneNumber = dataCursor.getString(DATA_COLUMN_PHONE_NUMBER);
                            long callDate = dataCursor.getLong(DATA_COLUMN_CALL_DATE);
                            String location = dataCursor.getString(DATA_COLUMN_CONTENT);

                            if (!TextUtils.isEmpty(phoneNumber)) { // 如果电话号码不为空
                                // 打印电话号码
                                ps.println(String.format(getFormat(FORMAT_NOTE_CONTENT),
                                        phoneNumber));
                            }
                            // 打印通话日期
                            ps.println(String.format(getFormat(FORMAT_NOTE_CONTENT), DateFormat
                                    .format(mContext.getString(R.string.format_datetime_mdhm),
                                            callDate)));
                            // 打印通话附件位置
                            if (!TextUtils.isEmpty(location)) { // 如果位置信息不为空
                                ps.println(String.format(getFormat(FORMAT_NOTE_CONTENT),
                                        location));
                            }
                        } else if (DataConstants.NOTE.equals(mimeType)) { // 如果是普通笔记类型
                            String content = dataCursor.getString(DATA_COLUMN_CONTENT); // 获取内容
                            if (!TextUtils.isEmpty(content)) { // 如果内容不为空
                                // 打印内容
                                ps.println(String.format(getFormat(FORMAT_NOTE_CONTENT),
                                        content));
                            }
                        }
                    } while (dataCursor.moveToNext()); // 移动到下一行
                }
                dataCursor.close();            // 关闭游标
            }
            // 在笔记之间打印分隔符
            try {
                ps.write(new byte[] {          // 写入字节数组
                        Character.LINE_SEPARATOR, // 行分隔符
                        Character.LETTER_NUMBER   // 字母数字字符
                });
            } catch (IOException e) {          // 捕获IO异常
                Log.e(TAG, e.toString());      // 记录错误日志
            }
        }

        /**
         * 将笔记导出为文本格式（用户可读）
         * @return 导出状态码
         */
        public int exportToText() {
            if (!externalStorageAvailable()) { // 检查外部存储是否可用
                Log.d(TAG, "Media was not mounted"); // 记录调试日志
                return STATE_SD_CARD_UNMOUONTED; // 返回SD卡未挂载状态
            }

            PrintStream ps = getExportToTextPrintStream(); // 获取打印流
            if (ps == null) {                  // 如果打印流为空
                Log.e(TAG, "get print stream error"); // 记录错误日志
                return STATE_SYSTEM_ERROR;     // 返回系统错误状态
            }
            
            // 首先导出文件夹及其笔记
            // 查询所有文件夹（排除垃圾箱）和通话记录文件夹
            Cursor folderCursor = mContext.getContentResolver().query(
                    Notes.CONTENT_NOTE_URI,
                    NOTE_PROJECTION,
                    "(" + NoteColumns.TYPE + "=" + Notes.TYPE_FOLDER + " AND "
                            + NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLER + ") OR "
                            + NoteColumns.ID + "=" + Notes.ID_CALL_RECORD_FOLDER, // 查询条件
                    null,                           // 查询参数
                    null);                          // 排序方式

            if (folderCursor != null) {             // 如果游标不为空
                if (folderCursor.moveToFirst()) {   // 如果游标移动到第一行
                    do {
                        // 打印文件夹名称
                        String folderName = "";     // 初始化文件夹名称为空
                        if(folderCursor.getLong(NOTE_COLUMN_ID) == Notes.ID_CALL_RECORD_FOLDER) {
                            // 如果是通话记录文件夹
                            folderName = mContext.getString(R.string.call_record_folder_name);
                        } else {
                            // 普通文件夹
                            folderName = folderCursor.getString(NOTE_COLUMN_SNIPPET);
                        }
                        if (!TextUtils.isEmpty(folderName)) { // 如果文件夹名称不为空
                            // 打印文件夹名称
                            ps.println(String.format(getFormat(FORMAT_FOLDER_NAME), folderName));
                        }
                        String folderId = folderCursor.getString(NOTE_COLUMN_ID); // 获取文件夹ID
                        exportFolderToText(folderId, ps); // 导出该文件夹下的笔记
                    } while (folderCursor.moveToNext()); // 移动到下一行
                }
                folderCursor.close();               // 关闭游标
            }

            // 导出根目录下的笔记（父ID为0的笔记）
            Cursor noteCursor = mContext.getContentResolver().query(
                    Notes.CONTENT_NOTE_URI,
                    NOTE_PROJECTION,
                    NoteColumns.TYPE + "=" + +Notes.TYPE_NOTE + " AND " + NoteColumns.PARENT_ID
                            + "=0",                // 查询条件：类型为笔记且父ID为0
                    null,                           // 查询参数
                    null);                          // 排序方式

            if (noteCursor != null) {               // 如果游标不为空
                if (noteCursor.moveToFirst()) {     // 如果游标移动到第一行
                    do {
                        // 打印笔记的修改日期
                        ps.println(String.format(getFormat(FORMAT_NOTE_DATE), DateFormat.format(
                                mContext.getString(R.string.format_datetime_mdhm), // 日期格式
                                noteCursor.getLong(NOTE_COLUMN_MODIFIED_DATE))));  // 修改日期
                        // 查询属于该笔记的数据
                        String noteId = noteCursor.getString(NOTE_COLUMN_ID); // 获取笔记ID
                        exportNoteToText(noteId, ps); // 导出该笔记的内容
                    } while (noteCursor.moveToNext()); // 移动到下一行
                }
                noteCursor.close();                 // 关闭游标
            }
            ps.close();                             // 关闭打印流

            return STATE_SUCCESS;                   // 返回成功状态
        }

        /**
         * 获取指向导出文件的打印流
         * @return 打印流对象，如果创建失败返回null
         */
        private PrintStream getExportToTextPrintStream() {
            // 生成文件
            File file = generateFileMountedOnSDcard(mContext, R.string.file_path,
                    R.string.file_name_txt_format);
            if (file == null) {                     // 如果文件为空
                Log.e(TAG, "create file to exported failed"); // 记录错误日志
                return null;                        // 返回null
            }
            mFileName = file.getName();             // 保存文件名
            mFileDirectory = mContext.getString(R.string.file_path); // 保存文件目录
            PrintStream ps = null;                  // 初始化打印流
            try {
                FileOutputStream fos = new FileOutputStream(file); // 创建文件输出流
                ps = new PrintStream(fos);          // 创建打印流
            } catch (FileNotFoundException e) {     // 捕获文件未找到异常
                e.printStackTrace();                // 打印异常堆栈
                return null;                        // 返回null
            } catch (NullPointerException e) {      // 捕获空指针异常
                e.printStackTrace();                // 打印异常堆栈
                return null;                        // 返回null
            }
            return ps;                              // 返回打印流
        }
    }

    /**
     * 在SD卡上生成用于存储导出数据的文本文件
     * @param context 上下文对象
     * @param filePathResId 文件路径资源ID
     * @param fileNameFormatResId 文件名格式资源ID
     * @return 生成的File对象，如果创建失败返回null
     */
    private static File generateFileMountedOnSDcard(Context context, int filePathResId, int fileNameFormatResId) {
        StringBuilder sb = new StringBuilder();     // 创建字符串构建器
        sb.append(Environment.getExternalStorageDirectory()); // 添加外部存储目录
        sb.append(context.getString(filePathResId)); // 添加文件路径
        File filedir = new File(sb.toString());     // 创建目录文件对象
        sb.append(context.getString(                 // 添加文件名
                fileNameFormatResId,                 // 文件名格式资源ID
                DateFormat.format(context.getString(R.string.format_date_ymd), // 日期格式
                        System.currentTimeMillis()))); // 当前时间
        File file = new File(sb.toString());        // 创建文件对象

        try {
            if (!filedir.exists()) {                // 如果目录不存在
                filedir.mkdir();                    // 创建目录
            }
            if (!file.exists()) {                   // 如果文件不存在
                file.createNewFile();               // 创建新文件
            }
            return file;                            // 返回文件对象
        } catch (SecurityException e) {             // 捕获安全异常
            e.printStackTrace();                    // 打印异常堆栈
        } catch (IOException e) {                   // 捕获IO异常
            e.printStackTrace();                    // 打印异常堆栈
        }

        return null;                                // 如果失败返回null
    }
}
[file content end]