×
¥
查看详情
🔥 会员专享 文生文 开发

Java变量命名智能建议

👁️ 75 次查看
📅 Dec 6, 2025
💡 核心价值: 本提示词专为Java开发者设计,提供专业、准确的变量命名建议。通过分析变量用途、数据类型和业务场景,结合Java命名规范和最佳实践,生成符合代码规范且语义清晰的变量名称。能够有效提升代码可读性和维护性,适用于业务系统开发、算法实现、API设计等多种Java编程场景,帮助开发者快速确定合适的变量命名方案。

🎯 可自定义参数(4个)

变量用途描述
描述变量的具体用途和功能
变量数据类型
变量的数据类型
业务场景
变量所在的业务场景或功能模块
命名风格偏好
期望的命名风格偏好

🎨 效果示例

  • 变量用途分析:

    • 表示订单层面的最终应付总额,单位为“分”,作为结算结果参与优惠抵扣后的金额汇总、与运费合并计算、风控限额校验以及账务入账等流程。数据类型为 long,强调以整数承载货币最小单位,避免精度问题。
  • 命名规范符合性:

    • 采用小驼峰命名(lowerCamelCase)。
    • 使用名词短语,包含“Amount”体现数值含义。
    • 明确单位后缀“InCents”,避免金额单位歧义。
    • 不使用不当缩写、不含拼音、不与保留字或标准库类名冲突。
    • 与 long 类型的“最小货币单位存储”实践一致。
  • 候选名称列表:

    1. orderPayableAmountInCents
      • 说明:突出“订单级别的应付金额”,适合出现在订单实体、结算结果DTO或跨服务传输对象中。
      • 优点:语义完整、上下文独立性强,适用于多上下文场景。
      • 可能的不足:名称较长。
    2. payableAmountInCents
      • 说明:应付金额(分)。适合在“订单上下文已明确”的类或方法内(如 Order 聚合内、收银台计算方法中)。
      • 优点:简洁、直观。
      • 可能的不足:在包含多种应付概念(如应付商品、应付运费、应付尾款)时可能不够区分。
    3. totalPayableAmountInCents
      • 说明:强调“应付总额”,表明该值是在折扣、运费合并后的最终值。
      • 优点:与“总额”语义贴合,有助于区分中间态金额(如应付原价、应付优惠后)。
      • 可能的不足:“total”在部分团队语境中需明确是否含税/含费,需文档配合说明。
    4. amountDueInCents
      • 说明:账单/支付领域常用表达“应付金额(分)”,适配收银台与支付侧。
      • 优点:行业通用词汇,易与支付系统对齐。
      • 可能的不足:未显式体现“订单级别”,在多域汇总时需上下文支撑。
    5. checkoutPayableAmountInCents
      • 说明:绑定“收银台计算阶段”的应付金额。
      • 优点:直接体现使用场景(收银台)。
      • 可能的不足:与业务流程阶段耦合较强,跨域(如账务入账)时可读性略弱。
  • 推荐方案:

    • 首选:orderPayableAmountInCents
    • 推荐理由:
      • 准确表达“订单级别 + 应付金额 + 单位为分”的完整语义,覆盖题述的优惠抵扣、运费合并、风控校验与账务入账等跨流程场景。
      • 在领域模型、服务间DTO以及日志审计中均具备足够的自解释性,减少语义误读。
      • 与 long 类型的“分”为单位的存储策略契合,避免单位混淆。
    • 作用域建议:
      • 若变量位于订单聚合或收银台结算方法内部且上下文明确,可使用更简洁的 payableAmountInCents。
      • 若需要特别强调“最终汇总值”,且同类对象中还有其他阶段性应付值,可选 totalPayableAmountInCents。
  • 使用注意事项:

    • 单位一致性:项目内金额字段建议统一采用“InCents”后缀(如 freightAmountInCents、discountAmountInCents),避免单位混用。
    • 语义边界:明确该值为“折扣后 + 运费合并后”的最终应付,不包含支付渠道手续费等额外费用;如包含税费,需在文档或命名中额外体现(例如 totalPayableTaxIncludedInCents)。
    • 数值约束:
      • 应为非负数;在风控或退款场景如出现调账,需在逻辑层明确处理而非依赖负值表达。
      • 注意极端大单场景下的 long 溢出风险(单价×数量×汇总);必要时增加边界校验或分段累加。
    • 上下文冗余:在“订单对象”内部字段时,“order”前缀可能冗余;在跨域DTO或日志中建议保留前缀以增强可读性。
    • 命名稳定性:尽量避免与流程阶段强绑定(如 checkout...),除非该变量仅在该阶段存在,避免后续复用时造成语义偏差。
  • 变量用途分析

    • 表示当前会话是否已完成登录认证(Authentication),用于接口鉴权、权限检查与受控资源访问的前置条件判断。
    • 语义核心:会话级别、已认证/未认证、布尔值。
  • 命名规范符合性

    • 使用小驼峰命名,语义清晰且与布尔类型相匹配(偏向 is/has 前缀或形容词态)。
    • 避免与“授权”(Authorization)混淆,聚焦“认证”(Authentication)。
    • 不使用否定式命名,避免双重否定导致的可读性问题。
  • 候选名称列表

    1. sessionAuthenticated
      • 含义:当前会话是否处于已认证状态。
      • 优点:明确作用域(会话级)、不与授权概念混淆;作为 JavaBean 字段时可生成 isSessionAuthenticated(),避免 is 前缀导致的 isIs 问题。
      • 适用:会话管理、鉴权过滤器、实体/DTO 字段。
    2. isSessionAuthenticated
      • 含义:会话是否已认证。
      • 优点:布尔语义直观;适合局部变量或条件判断使用。
      • 缺点:若作为 JavaBean 字段名,可能与部分框架的属性解析产生不一致(生成 isIsSessionAuthenticated 风险),不如无 is 前缀安全。
      • 适用:方法内临时变量、条件表达式。
    3. authenticated
      • 含义:是否已认证(默认指当前上下文/会话)。
      • 优点:最简洁;JavaBean 字段名自然生成 isAuthenticated()。
      • 缺点:作用域不够直观,需依赖上下文理解“是会话级还是用户级”。
      • 适用:上下文已明确是会话语境的代码(如 Session/Filter 内部)。
    4. isAuthenticated
      • 含义:是否已认证。
      • 优点:布尔直觉强;与通用术语一致。
      • 缺点:作为字段名在部分框架的属性映射可能出现 is 前缀二次解析问题;且容易与 Spring Security 的 isAuthenticated 概念混淆。
      • 适用:方法内局部变量、与框架方法名对齐的临时标志。
    5. loginVerified
      • 含义:是否完成登录校验。
      • 优点:贴近“登录验证”表述。
      • 缺点:偏业务词“登录”,在 Token/SSO 等非显式登录场景语义不够广泛;不如“authenticated”准确。
      • 适用:确实以“登录流程”为核心的场景。
  • 推荐方案

    • 首选变量名:sessionAuthenticated
    • 推荐理由:
      • 语义准确:突出“会话级已认证”这一核心含义,避免与授权(authorized)混淆。
      • 可读性强:一眼可知作用域与状态,适合鉴权过滤器和会话管理代码。
      • 规范友好:作为字段可生成 isSessionAuthenticated(),既符合 JavaBean 习惯,又避免字段名以 is 开头带来的潜在解析问题。
      • 兼顾简洁:在明确会话语境下足够简短,比冗长的命名更易读。
  • 使用注意事项

    • 与授权区分:不要使用 authorized/hasPermission 之类名称,此变量仅表示“认证完成”,非“已授权”。
    • 避免否定式:避免 notAuthenticated、unauthenticated 等命名,条件判断更易产生误读。
    • Bean 属性命名:若作为类字段并暴露给框架(序列化/绑定),优先使用 sessionAuthenticated 或 authenticated,避免以 is 开头的字段名导致 isIs... 的 getter。
    • 上下文一致性:在 Filter/Interceptor 中,确保该标志与实际认证来源一致(Cookie/Token/SSO),若存在匿名访问或部分认证态,考虑引入更精细的状态枚举或额外变量(例如 authenticationLevel)。

变量用途分析

  • 存放富文本编辑器输出的文章正文 HTML 内容(包含段落、标题、内嵌图片、代码块)。
  • 用途:在 CMS 的文章发布与预览流程中用于页面渲染,并作为全文索引的原始来源。
  • 数据类型:String;生命周期通常为实体字段或 DTO 字段,也可能在服务层作为中间变量。

命名规范符合性

  • 使用小驼峰命名法(lowerCamelCase),变量名以名词/名词短语为主。
  • 缩略词 “HTML” 按 Java 惯例写作 “Html”(仅首字母大写),如:articleBodyHtml。
  • 不包含不当缩写、拼音或含糊词;不与 Java 保留字或标准库类名冲突。
  • 名称体现“是什么”(文章正文的 HTML),不过度编码“怎么用”(渲染/索引),避免职责耦合。

候选名称列表

  1. articleBodyHtml

    • 说明:明确表示“文章正文的 HTML”。在有多字段(标题、摘要、封面等)的文章模型中可清晰区分“正文”。
    • 优点:语义准确、简洁;上下游开发者易于理解。
    • 适用场景:实体/DTO字段,服务层通用变量。
  2. articleContentHtml

    • 说明:表示“文章内容的 HTML”。“content”更通用。
    • 优点:通用性强。
    • 可能问题:在同时存在 summary/abstract/description 时,“content”可能与这些概念混淆;不如“body”聚焦“正文”。
  3. richTextContentHtml

    • 说明:强调来源是富文本(rich text)编辑器生成的 HTML。
    • 优点:来源清晰;适合靠近编辑器边界(接收/转换)处使用。
    • 可能问题:在远离编辑器的业务层,这种来源信息价值降低,名称略显冗长。
  4. editorOutputHtml

    • 说明:突出“来自编辑器的输出 HTML”,强调“原始产物”语义。
    • 优点:非常适合短生命周期、紧邻输入边界(Controller/Adapter)的变量名,便于和“清洗后/转码后”区分。
    • 可能问题:偏过程性,强调来源而非实体语义;不适合作为实体字段的长期命名。
  5. bodyHtml

    • 说明:简化形式的“正文 HTML”,依赖外层上下文(如 Article 类)。
    • 优点:在 Article 实体内部字段时足够清晰且更简洁。
    • 可能问题:在离开 Article 上下文的地方会显得语义不足;不符合“详细描述”偏好。

推荐方案

  • 推荐名称:articleBodyHtml
  • 推荐理由:
    • 语义聚焦:清楚指向“文章的正文”(body),区别于 title、summary、cover 等同级字段。
    • 表意完整:同时标明承载格式为 Html,避免与纯文本正文混淆。
    • 适配范围广:既适合作为 Article/ArticleDTO 的字段,也适合作为服务层变量;满足“详细描述”的风格偏好且不过度冗长。
    • 符合规范:小驼峰 + 合理处理缩略词(Html),无歧义、不依赖上下文才能理解。

使用注意事项

  • 若存在“原始 HTML”和“安全清洗后 HTML”两种形态,建议区分命名:
    • 原始:rawArticleBodyHtml(仅在确需强调“未清洗”时使用)
    • 清洗:sanitizedArticleBodyHtml 或 safeArticleBodyHtml
  • 若同时保存纯文本以便索引或摘要生成,建议并列字段:
    • articleBodyText(纯文本,去标签后)
  • 避免把用途编码进名称(如 forRendering、forIndexing),保持“描述数据本身”的命名原则。
  • 在 Article 类内部字段可使用更短的 bodyHtml,但在跨上下文(DTO、服务间)传递时更建议使用 articleBodyHtml,减少语义依赖。
  • 若存在多格式并存(如 Markdown 与 HTML),需在命名中显式标注格式以避免混淆(articleBodyMarkdown / articleBodyHtml)。

示例详情

📖 如何使用

30秒出活:复制 → 粘贴 → 搞定
与其花几十分钟和AI聊天、试错,不如直接复制这些经过千人验证的模板,修改几个 {{变量}} 就能立刻获得专业级输出。省下来的时间,足够你轻松享受两杯咖啡!
加载中...
💬 不会填参数?让 AI 反过来问你
不确定变量该填什么?一键转为对话模式,AI 会像资深顾问一样逐步引导你,问几个问题就能自动生成完美匹配你需求的定制结果。零门槛,开口就行。
转为对话模式
🚀 告别复制粘贴,Chat 里直接调用
无需切换,输入 / 唤醒 8000+ 专家级提示词。 插件将全站提示词库深度集成于 Chat 输入框。基于当前对话语境,系统智能推荐最契合的 Prompt 并自动完成参数化,让海量资源触手可及,从此彻底告别"手动搬运"。
即将推出
🔌 接口一调,提示词自己会进化
手动跑一次还行,跑一百次呢?通过 API 接口动态注入变量,接入批量评价引擎,让程序自动迭代出更高质量的提示词方案。Prompt 会自己进化,你只管收结果。
发布 API
🤖 一键变成你的专属 Agent 应用
不想每次都配参数?把这条提示词直接发布成独立 Agent,内嵌图片生成、参数优化等工具,分享链接就能用。给团队或客户一个"开箱即用"的完整方案。
创建 Agent

✅ 特性总结

输入用途与类型后,轻松生成规范清晰的Java变量名,并附简要含义说明。
一次给出多套命名方案,标注适用场景与取舍理由,快速选定最优名称。
针对电商、金融、物联网等领域词汇自动对齐术语,避免歧义与误解。
自动排除保留字、易混淆缩写与不当风格,减少审核返工与沟通成本。
面向API参数、实体字段、算法变量分别优化策略,贴合真实开发场景。
考虑作用域与生命周期给出恰当粒度命名,提升可读性与后续维护效率。
生成命名规范符合性说明,帮助团队统一风格,加快代码评审通过率。
支持个性化风格偏好微调,在简洁与表达力间平衡,保持一致审美。
提供使用注意事项与边界提示,提前规避命名陷阱与潜在上线风险。

🎯 解决的问题

为Java开发者与团队在业务开发、算法实现、接口参数设计等核心场景中,快速生成规范统一、语义到位的变量命名。通过一次性输入用途、类型与业务语境,立即获得多套候选方案与明确推荐理由,帮助统一团队风格、提升代码可读性和评审通过率,缩短交付周期并降低后期维护与沟通成本,最终沉淀可复用的命名标准。

🕒 版本历史

当前版本
v2.1 2024-01-15
优化输出结构,增强情节连贯性
  • ✨ 新增章节节奏控制参数
  • 🔧 优化人物关系描述逻辑
  • 📝 改进主题深化引导语
  • 🎯 增强情节转折点设计
v2.0 2023-12-20
重构提示词架构,提升生成质量
  • 🚀 全新的提示词结构设计
  • 📊 增加输出格式化选项
  • 💡 优化角色塑造引导
v1.5 2023-11-10
修复已知问题,提升稳定性
  • 🐛 修复长文本处理bug
  • ⚡ 提升响应速度
v1.0 2023-10-01
首次发布
  • 🎉 初始版本上线
COMING SOON
版本历史追踪,即将启航
记录每一次提示词的进化与升级,敬请期待。

💬 用户评价

4.8
⭐⭐⭐⭐⭐
基于 28 条评价
5星
85%
4星
12%
3星
3%
👤
电商运营 - 张先生
⭐⭐⭐⭐⭐ 2025-01-15
双十一用这个提示词生成了20多张海报,效果非常好!点击率提升了35%,节省了大量设计时间。参数调整很灵活,能快速适配不同节日。
效果好 节省时间
👤
品牌设计师 - 李女士
⭐⭐⭐⭐⭐ 2025-01-10
作为设计师,这个提示词帮我快速生成创意方向,大大提升了工作效率。生成的海报氛围感很强,稍作调整就能直接使用。
创意好 专业
COMING SOON
用户评价与反馈系统,即将上线
倾听真实反馈,在这里留下您的使用心得,敬请期待。
加载中...