diff --git a/tamguo-common/src/main/java/com/tamguo/common/utils/SystemConstant.java b/tamguo-common/src/main/java/com/tamguo/common/utils/SystemConstant.java index fec3261..2db9143 100644 --- a/tamguo-common/src/main/java/com/tamguo/common/utils/SystemConstant.java +++ b/tamguo-common/src/main/java/com/tamguo/common/utils/SystemConstant.java @@ -1,103 +1,105 @@ package com.tamguo.common.utils; +// SystemConstant类主要用于定义项目中的各种常量，将这些常量集中管理，方便在整个项目中统一使用，提高代码的可读性和可维护性，避免在多处使用硬编码的字符串或数值，一旦需要修改常量值，只需在一处进行调整即可。 + public class SystemConstant { - - /** 初始密码*/ + + // 定义初始密码的常量，其值为"123456"，通常用于新用户首次登录或者重置密码等场景下设置默认的初始密码，在整个项目中涉及到初始密码相关的逻辑判断、赋值操作时都可以使用该常量，保证一致性。 public static final String INIT_PASSWORD = "123456"; - - /** 验证码常数*/ + + // 用于表示验证码相关操作中在会话（Session）中存储验证码的键（Key），在生成验证码并将其存储到会话中，以及后续验证用户输入的验证码时，通过这个统一的键来获取和操作对应的验证码信息，保证验证码在整个验证流程中的一致性和准确性。 public static final String KAPTCHA_SESSION_KEY = "KAPTCHA_SESSION_KEY"; - /** 验证码常数*/ + // 可能用于标识系统用户的特定代码，值为"system"，比如在区分不同类型用户（普通用户、系统管理员等）的业务逻辑中，用该常量来代表系统相关的特殊用户角色，便于进行权限判断、系统操作相关的逻辑处理等。 public static final String SYSTEM_USER_CODE = "system"; - - /** 首页菜单缓存KEY*/ + + // 用于作为首页菜单缓存的键（Key），在缓存首页菜单数据时，通过这个键来存储和获取相应的缓存内容，方便提高首页菜单数据的访问速度，减少重复查询数据库等操作，提升系统性能，每次访问首页菜单时可通过该键从缓存中获取数据（若缓存命中）。 public static final String INDEX_MENU = "index_menu"; - - /** 首页菜单缓存KEY*/ + + // 同样是首页菜单缓存的键（Key），可能与`INDEX_MENU`有所区别，也许用于存储全部的首页菜单相关数据（具体区别取决于业务逻辑对菜单数据的不同划分和使用场景），便于在需要获取完整首页菜单信息时通过该键从缓存中查找数据。 public static final String ALL_INDEX_MENU = "all_index_menu"; - - /** 首页左侧菜单缓存KEY*/ + + // 作为首页左侧菜单缓存的键（Key），在缓存首页左侧部分的菜单数据时使用，方便快速获取首页左侧菜单内容，优化这部分菜单数据的加载速度，适用于首页布局中左侧菜单有单独的缓存管理和数据获取需求的情况。 public static final String LEFT_INDEX_MENU = "left_index_menu"; - - /** 首页章节学习缓存KEY*/ + + // 用于作为首页章节学习相关菜单缓存的键（Key），当有涉及章节学习部分的菜单数据需要缓存时，通过这个键进行缓存操作，便于后续快速展示章节学习相关的菜单内容，提高用户体验和系统性能。 public static final String CHAPTER_INDEX_MENU = "chapter_index_menu"; - - /** 首页底部菜单缓存KEY*/ + + // 作为首页底部菜单缓存的键（Key），用于缓存首页底部展示的菜单数据，使得在加载首页底部菜单时能够快速从缓存中获取，避免重复的数据库查询或者复杂的菜单生成操作，加快页面加载速度。 public static final String FOOTER_INDEX_MENU = "footer_index_menu"; - - /** 首页热门试卷缓存KEY*/ + + // 用作首页热门试卷缓存的键（Key），在缓存热门试卷相关数据时使用该键，方便快速提供热门试卷信息给前端页面展示，减少查询热门试卷数据的时间消耗，提升用户获取热门试卷列表的速度。 public static final String HOT_PAPER = "HOT_PAPER"; - - /** 北京地区ID*/ + + // 定义北京地区的唯一标识符（ID），值为"110000"，在涉及地区相关的业务逻辑中，比如根据地区筛选数据、统计不同地区的业务情况等场景下，通过该常量来代表北京地区，确保地区标识的一致性和准确性。 public static final String BEIJING_AREA_ID = "110000"; - /** 真题类型ID*/ + // 用于标识真题类型试卷的唯一标识符（ID），值为"1"，在试卷管理、分类查询（如用户查询真题试卷）等业务逻辑中，通过该常量来区分不同类型的试卷，便于准确筛选出真题类型的试卷进行相应操作。 public static final String ZHENGTI_PAPER_ID = "1"; - - /** 模拟类型ID */ + + // 表示模拟类型试卷的唯一标识符（ID），值为"2"，与其他试卷类型的ID常量一起，用于在试卷分类、筛选以及相关业务处理中，准确识别模拟试卷，方便按照模拟试卷类型进行数据操作和展示等工作。 public static final String MONI_PAPER_ID = "2"; - - /** 押题预测ID */ + + // 用于标识押题预测类型试卷的唯一标识符（ID），值为"3"，在试卷管理、向用户展示不同类型试卷等场景下，通过该常量来区分押题预测试卷，以便进行针对性的业务处理和数据呈现。 public static final String YATI_PAPER_ID = "3"; - - /** 名校精品ID */ + + // 代表名校精品类型试卷的唯一标识符（ID），值为"4"，方便在涉及名校试卷相关的业务逻辑中，如筛选、推荐名校试卷等操作时，准确界定属于名校精品类型的试卷，进行相应的数据处理和展示。 public static final String MINGXIAO_PAPER_ID = "4"; - /** 首页历年真题缓存KEY*/ + // 作为首页历年真题缓存的键（Key），并且可能根据具体业务逻辑会在后面拼接一些其他标识信息（从名称中的":"可推测），用于缓存历年真题试卷相关的数据，便于快速获取和展示历年真题内容给用户，优化真题数据的访问性能。 public static final String HISTORY_PAPER = "HistoryPaper:"; - - /** 首页模拟试卷缓存KEY*/ + + // 首页模拟试卷缓存的键（Key），同样可能后续会拼接其他必要信息，用于存储和获取模拟试卷相关的数据缓存，方便在需要展示模拟试卷列表等情况时，快速从缓存中提取数据，减少数据获取时间，提升页面响应速度。 public static final String SIMULATION_PAPER = "SimulationPaper:"; - - /** 名校试卷缓存KEY*/ + + // 名校试卷缓存的键（Key），用于缓存与名校相关的试卷数据，在涉及名校试卷展示、查询等业务场景下，通过该键从缓存中获取相应的数据，提高名校试卷数据的访问效率，提升用户体验。 public static final String ELITE_SCHOOL_PAPER = "EliteSchoolPaper:"; - - /** 所有广告缓存KEY*/ + + // 用于缓存所有广告相关信息的键（Key），在广告管理、展示广告等业务逻辑中，通过该常量作为缓存的标识，方便快速获取所有广告数据，例如在页面加载时快速填充广告位等操作，提高广告数据的使用效率。 public static final String ALL_AD = "AllAd:"; - - /** 名校缓存KEY*/ + + // 名校相关缓存的键（Key），具体用途可能与名校的其他数据缓存有关（比如名校详情、名校分类等相关数据，具体取决于业务对名校数据的缓存划分），便于在需要获取名校相关缓存信息时进行查找和使用。 public static final String ELITE_PAPER = "ElitePaper:"; - - /** 安全验证前缀*/ + + // 安全验证相关操作中使用的前缀，比如在生成安全验证相关的标识、存储验证记录等场景下，使用该前缀来统一命名相关的数据，方便在业务逻辑中识别和区分安全验证相关的数据项，保证安全验证流程的规范性和一致性。 public static final String SECURITY_CHECK_PREFIX = "securityCheck:"; - - /** 短信找回密码前缀*/ + + // 短信找回密码相关操作中使用的前缀，在生成短信验证码、存储短信找回密码相关记录等业务场景下，通过该前缀来标识与短信找回密码相关的数据，便于统一管理和区分不同业务用途的数据，确保短信找回密码流程的准确执行。 public static final String ALIYUN_MOBILE_SMS_PREFIX = "MOBILE_SMS_PREKEY_"; - - /** 默认会员头像*/ + + // 定义默认会员头像的文件路径，值为"/images/avatar.png"，在用户未上传自定义头像时，系统默认显示该头像图片，整个项目中涉及会员头像展示且用户无自定义头像的情况时，都可以使用该常量指定的路径来获取默认头像图片进行展示。 public static final String DEFAULT_MEMBER_AVATAR = "/images/avatar.png"; - - /** 登录错误次数*/ + + // 用于标识登录错误次数相关数据的前缀，在记录用户登录失败次数、判断是否达到登录错误次数限制等与登录错误次数相关的业务逻辑中，通过该前缀来命名相关的数据存储项（比如可能结合用户名等作为完整的键来存储每个用户的登录错误次数），便于统一管理和操作登录错误次数相关的信息。 public static final String LOGIN_FAILURE_COUNT = "loginFailureCount:"; - - /** ALIYUN */ + + // 阿里云相关服务的访问密钥ID（Access Key ID），值为"LTAINGkheMeWtxUR"，用于在项目中与阿里云的某些服务（如存储、短信、邮件等服务，具体取决于业务集成情况）进行身份验证，确保有权限访问对应的阿里云资源，该值应妥善保管，不能随意泄露。 public static final String ALIYUN_ACCESS_KEY_ID = "LTAINGkheMeWtxUR"; - - /** ALIYUN*/ + + // 阿里云相关服务的访问密钥（Access Key Secret），值为"ONUKuCz85kU4In07y4dvpM28mfWOGa"，与访问密钥ID配合使用，用于对阿里云服务进行更安全的身份认证，同样需要严格保密，它是访问阿里云资源的重要凭证之一，涉及到与阿里云交互的业务逻辑中用于验证身份。 public static final String ALIYUN_ACCESS_KEY_SECRET = "ONUKuCz85kU4In07y4dvpM28mfWOGa"; - - /** 默认的章节根目录*/ + + // 定义默认的章节根目录的唯一标识符（UID），值为"-1"，在章节管理相关的业务逻辑中，比如构建章节树结构、判断章节层级关系等场景下，使用该常量来标识默认的根目录节点，便于统一处理章节的组织结构和层次关系。 public static final String CHAPTER_DEFAULT_ROOT_UID = "-1"; - /** 所有地区*/ + // 用于缓存所有地区相关信息的键（Key），在涉及地区数据查询、展示（如选择地区下拉框展示所有地区列表等场景）的业务逻辑中，通过该常量作为缓存标识，方便快速获取所有地区的数据，减少重复查询地区数据的开销，提高系统性能。 public static final String AREA_ALL_TREE = "AREAALL:"; - - /** ALIYUN*/ + + // 阿里云的SMTP服务器主机名，值为"smtp.aliyun.com"，在使用阿里云邮件服务发送邮件时，需要指定该SMTP服务器地址来建立邮件发送连接，确保邮件能够正确地通过阿里云的邮件服务发送出去，是邮件发送配置中的重要参数之一。 public static final String ALIYUN_SMTP_HOST_NAME = "smtp.aliyun.com"; - - /** ALIYUN*/ + + // 阿里云的SMTP服务器主机端口号，值为465，与阿里云的SMTP主机名配合使用，用于建立与阿里云邮件服务的安全连接（通常465端口用于SSL加密连接），确保邮件发送过程中的数据安全，是邮件发送配置中必不可少的端口参数。 public static final int ALIYUN_SMTP_HOST_PORT = 465; - - /** ALIYUN*/ + + // 阿里云邮件服务的账号，此处为空字符串，实际应用中应填写合法有效的阿里云邮箱账号，用于在通过阿里云邮件服务发送邮件时进行身份验证，表明发件人的身份，确保邮件能够从正确的账号发送出去。 public static final String ALIYUN_MAIL_ACCOUNT = ""; - - /** ALIYUN*/ + + // 阿里云邮件服务对应的密码，此处为空字符串，实际使用时需要填入与阿里云邮件账号对应的正确密码，与账号一起用于登录阿里云邮件服务，进行邮件发送操作的身份验证，保障邮件发送的合法性和安全性。 public static final String ALIYUN_MAIL_PASSWORD = ""; - - /** 邮件主题*/ + + // 定义使用阿里云邮件服务发送找回密码相关邮件时的邮件主题，值为"探果网找回密码"，用于明确邮件的大致内容和用途，方便收件人快速了解邮件的核心信息，在邮件发送逻辑中作为固定的主题设置，保证邮件主题的一致性。 public static final String ALIYUN_MAIL_SUBJECT_FINDPASSWORD = "探果网找回密码"; - /** 邮箱找回密码前缀*/ + // 邮箱找回密码相关操作中使用的前缀，在生成邮箱找回密码相关的验证信息、存储记录等场景下，通过该前缀来标识与邮箱找回密码相关的数据，便于统一管理和区分不同业务流程的数据，确保邮箱找回密码流程的规范执行。 public static final String ALIYUN_MAIL_FIND_PASSWORD_PREFIX = "EMAIL_FIND_PASSWORD_"; -} +} \ No newline at end of file