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

Java包描述生成专家

👁️ 71 次查看
📅 Dec 6, 2025
💡 核心价值: 本提示词专为Java开发场景设计,能够根据提供的包结构信息生成专业、准确的技术文档描述。它采用系统化的分析流程,首先解析包的核心功能,然后识别关键类和接口,接着分析技术架构特点,最后生成结构清晰、技术准确、符合Java开发规范的包描述文档。适用于项目文档编写、代码库维护、技术交接等多种开发场景,帮助开发团队快速建立规范的技术文档体系。

🎯 可自定义参数(4个)

包结构
Java包的完整路径和层级结构
包功能
包提供的主要功能和服务
技术特性
包的技术实现特点和架构设计
核心组件
包内主要类和接口的名称

🎨 效果示例

io.shop.order 包技术描述

包概述

io.shop.order 面向订单领域,基于 DDD 分层(api/application/domain/infra)实现订单创建、定价与优惠结算、库存预占、支付回调、生命周期状态流转与查询能力。对外提供 REST 接口与领域服务,支持领域事件通知与审计追踪,保证高并发场景下的数据一致性与可观测性。

主要功能

  • 订单创建
    • 接收并校验下单请求
    • 构建订单聚合并完成定价与优惠结算
    • 持久化聚合并发布订单创建相关领域事件
  • 定价与优惠结算
    • 封装定价策略与优惠计算
    • 产出订单应付金额与明细
  • 库存预占
    • 基于领域事件与本地消息表触发库存系统预占流程
    • 确保消息的可靠投递与最终一致
  • 支付回调处理
    • 接收支付网关回调,完成签名与参数校验(由网关适配层/控制器负责)
    • 驱动订单状态机进行状态流转并持久化
  • 状态流转与查询
    • 使用状态机驱动订单生命周期变更(含校验与动作)
    • 基于查询规格(Specification)进行条件查询与分页检索
  • 事件通知与审计追踪
    • 以领域事件作为上下游交互与解耦手段
    • 审计切面记录关键操作与变更轨迹

核心组件

  • io.shop.order.api
    • OrderController(REST入口)
      • 职责:暴露下单、查询、状态操作等 REST 接口;请求校验与DTO绑定;调用应用服务
    • PaymentCallbackHandler(支付回调)
      • 职责:接收支付回调请求,完成基础校验与参数解析,委派应用服务/领域流程处理
  • io.shop.order.application
    • OrderAppService(用例服务)
      • 职责:编排用例流程(创建订单、支付结果处理、取消/变更等);调用领域服务与仓储;作为事务与一致性协调入口
  • io.shop.order.domain.model
    • Order(聚合根)
      • 职责:维护订单核心状态与不变式;对外提供领域行为(创建、变更、校验);通过版本号控制并发
    • OrderItem(实体)
      • 职责:表示订单行项目,承载计价与数量约束
    • OrderRepository(仓储接口)
      • 职责:定义聚合的持久化契约(保存、查询、按条件检索等)
  • io.shop.order.domain.service
    • PricingService(定价)
      • 职责:封装定价与优惠结算策略,输出计费结果
    • OrderStateMachine(状态机)
      • 职责:定义订单生命周期状态、转换条件与状态迁移动作;对非法流转进行保护
  • io.shop.order.infra.repo
    • JpaOrderRepository(仓储实现)
      • 职责:基于 JPA 实现 OrderRepository;处理数据映射与乐观锁落盘
    • OrderSpec(查询规格)
      • 职责:封装动态查询条件(如按时间、状态、买家等),供仓储检索
  • io.shop.order.infra.mapper
    • OrderMapper(DTO转换)
      • 职责:使用 MapStruct 在 DTO 与领域对象/持久化对象间转换
  • io.shop.order.config
    • AuditLogAspect(审计切面)
      • 职责:切面化拦截关键操作,记录审计日志;与统一异常/日志策略协同

技术特性

  • 分层与依赖约束
    • api → application → domain → infra 自顶向下依赖;domain 不依赖基础设施,保持纯粹
  • Spring Boot + JPA
    • 聚合与实体映射至关系数据库;使用 JPA @Version(或等效机制)实现乐观锁与版本控制
  • 状态机驱动生命周期
    • 由 OrderStateMachine 管控状态与流转规则;应用服务在事务内驱动流转并持久化
  • 领域事件 + 本地消息表
    • 事件在事务内落地本地消息表;由消息转发器(基础设施层)异步投递,保障最终一致
  • MapStruct 与 Bean 校验
    • MapStruct 负责 DTO/DO/领域对象间高性能类型转换
    • Bean Validation 在 api 层进行入参约束校验,减少无效请求进入领域
  • 统一异常与审计
    • 统一异常策略将领域与基础设施异常标准化为API响应
    • 审计切面记录关键读写与状态变更,支持问题追踪与合规审计

使用场景

  • 提交订单
    1. OrderController 接收下单请求并校验
    2. OrderAppService 调用 PricingService 完成定价与优惠
    3. 创建 Order 聚合并持久化(OrderRepository → JpaOrderRepository)
    4. 发布订单创建领域事件,写入本地消息表以触发库存预占
  • 支付回调处理
    1. PaymentCallbackHandler 接收回调并完成参数校验/解析
    2. OrderAppService 调用 OrderStateMachine 进行状态流转(如从待支付到已支付)
    3. 持久化变更并发布相应领域事件(用于通知发货/营销等系统)
  • 订单查询
    1. OrderController 接收查询条件
    2. OrderSpec 组合查询条件;仓储检索数据
    3. OrderMapper 转换为响应 DTO 返回
  • 订单状态操作(如取消)
    1. OrderController 接收业务指令
    2. OrderAppService 驱动 OrderStateMachine 校验并流转
    3. 仓储持久化与事件发布,审计切面记录操作轨迹

以上描述对应包结构 io.shop.order.{api,application,domain.{model,service},infra.{repo,mapper},config} 及所列核心类与功能范围,体现 DDD 分层、状态机驱动与事件一致性的技术实现要点。

包概述

com.legacy.crm.customer 包围绕客户域构建,提供客户档案、联系人、标签与跟进日志的管理能力,并支持客户分级与评分、线索合并去重、批量导入导出以及数据权限控制,支撑销售流程与统计。采用传统三层(Web/Service/DAO)与领域建模结合的结构,基于 Spring MVC + MyBatis 实现,辅以分库分表与读写分离、Redis 与本地二级缓存、binlog 增量同步、Bean Validation、统一错误码、对象转换(MapStruct/Dozer)以及 AOP 审计与灰度开关等技术手段,确保在高并发与复杂业务场景下的性能与一致性。

主要功能

  • 客户档案管理
    • 维护 Customer 聚合及其属性、生命周期操作;支持联系人(Contact)、标签(Tag)与跟进日志(FollowUpLog)等关联信息的读写。
  • 客户分级与评分
    • 结合 domain.policy 的领域策略进行客户等级与评分计算,支持在服务层对评分结果进行持久化或缓存。
  • 线索合并与去重
    • 通过 CustomerDedupService 进行重复检测与合并,消除冗余数据,保持客户唯一性。
  • 批量导入与导出
    • ImportExportFacade 提供导入校验、结果汇总与导出能力,支持大批量数据处理。
  • 数据权限控制
    • 通过 DataScopeAspect 在控制器或服务层切面织入权限约束,实现基于组织/角色/负责人等维度的数据可见性控制。
  • 跟进记录与标签管理
    • 维护客户跟进日志、标签的增删改查,支撑销售过程记录与标注。
  • 读写分离与缓存加速
    • 读操作优先从只读库与缓存命中,写操作路由主库并触发缓存更新与增量同步。
  • 增量同步
    • BinlogListener 监听数据库变更事件,驱动缓存失效/刷新与下游系统同步,确保数据近实时一致。

核心组件

  • com.legacy.crm.customer.web
    • CustomerController
      • 职责:提供页面与 REST API;接收请求、参数校验(Bean Validation)、调用服务层、输出统一错误码规范的响应;结合 DataScopeAspect 实施数据权限。
  • com.legacy.crm.customer.service
    • CustomerService
      • 职责:客户域核心业务服务;封装聚合内操作(档案、联系人、标签、跟进日志)、分级评分调用、事务控制与缓存协调。
    • CustomerDedupService
      • 职责:去重策略与合并流程编排;调用仓储与映射层完成重复检测、合并写入及一致性维护。
    • ImportExportFacade
      • 职责:批量导入导出门面;执行数据校验、转换、分片处理与结果汇总;与仓储、缓存和增量同步机制协作。
  • com.legacy.crm.customer.domain.model
    • Customer(聚合根)
      • 职责:承载客户核心属性与不变式;聚合内管理联系人、标签、跟进日志等子对象的一致性。
    • Contact(值对象)
      • 职责:客户联系人信息的不可变建模;参与聚合内校验与比较。
    • Tag(标签)
      • 职责:客户标签标注;用于分群与检索。
    • FollowUpLog(日志)
      • 职责:跟进记录条目;承载时间、内容、执行人等信息。
  • com.legacy.crm.customer.domain.policy
    • 职责:客户分级、评分等领域策略的接口与实现集合;由服务层在业务流程中调用以产出决策结果。
  • com.legacy.crm.customer.dao
    • CustomerRepository(仓储接口)
      • 职责:面向领域的持久化抽象;隐藏 MyBatis 细节,提供聚合级读写能力。
    • CustomerMapper(MyBatis)
      • 职责:SQL 映射与数据访问;支持分库分表与读写分离策略的路由。
  • com.legacy.crm.customer.convert
    • Convertor(对象转换)
      • 职责:基于 MapStruct/Dozer 的对象转换抽象;完成 DTO/VO 与领域模型、持久化对象之间的映射。
  • com.legacy.crm.customer.config
    • DataScopeAspect(数据权限)
      • 职责:基于 AOP 的数据范围校验与过滤;在控制器/服务方法执行前后实施权限控制。
    • BinlogListener(增量同步)
      • 职责:订阅/监听数据库 binlog;对变更事件进行解析与分发,驱动缓存更新与下游同步。
    • 其他配置(说明)
      • 职责:Spring MVC、MyBatis、数据源(分库分表、读写分离)、Redis、本地缓存、统一错误码、审计与灰度开关等相关配置与切面。

技术特性

  • 分层与领域建模结合
    • Web -> Service -> DAO 的依赖单向闭环,Service 以内聚领域模型(Customer 聚合)实现业务规则,DAO 通过仓储接口解耦持久化细节。
  • Spring MVC + MyBatis
    • 控制器暴露页面与 API;MyBatis 承担 SQL 映射,结合分库分表策略进行路由;Repository 隐藏 Mapper 细节,维持聚合一致性存取。
  • 分库分表与读写分离
    • 写操作路由主库,读操作优先只读库;服务层在事务边界内协调写入与缓存失效,避免脏读。
  • 多级缓存
    • Redis 作为分布式一级缓存,本地二级缓存作为热点加速;写路径触发失效或更新,读路径命中失败回源数据库并回填。
  • Binlog 增量同步
    • BinlogListener 监听数据库变更,推送缓存刷新并向下游同步,降低强一致开销并提升近实时一致性。
  • Bean Validation 与统一错误码
    • 控制器与服务层参数校验统一化;异常到错误码的转换保证对外接口一致性与可观测性。
  • 对象转换(MapStruct/Dozer)
    • Convertor 统一对象映射约束,降低层间耦合,保证 DTO/领域/持久化对象的字段一致性。
  • AOP 审计与灰度开关
    • 通过切面记录关键操作审计日志;灰度开关控制新策略或新路径的逐步放量,保障变更可控。
  • 数据权限控制
    • DataScopeAspect 在执行链路上应用数据范围过滤,确保查询与变更受控。
  • 事务与一致性
    • 以服务层为事务边界,通过仓储提交聚合变更;结合缓存失效策略与 binlog 同步降低不一致窗口。

使用场景

  • 客户建档与维护
    • CustomerController 接收请求 -> 参数校验 -> 调用 CustomerService -> 更新仓储(主库)-> 失效缓存 -> BinlogListener 推送增量事件。
  • 客户分级与评分
    • 服务层装配领域策略(domain.policy),计算等级与分数,并根据策略结果更新持久化与缓存。
  • 线索去重与合并
    • CustomerDedupService 基于既定去重规则检测重复,合并聚合数据,统一写入主库并触发缓存与增量同步。
  • 批量导入与导出
    • ImportExportFacade 负责文件解析、数据校验、对象转换与分批写入/读取;汇总结果并输出统计。
  • 查询与列表检索
    • DataScopeAspect 施加权限过滤;读路径优先本地/Redis 缓存,未命中回源只读库,结果回填缓存。
  • 跟进记录与标签管理
    • 在聚合内维护 FollowUpLog 与 Tag,服务层保证聚合约束与事务一致性,DAO/Mapper 持久化相应变更。

包概述

org.toolkit.logging 提供统一的日志抽象与桥接能力,面向库和业务服务形成一致的日志规范。框架通过 SPI 扩展与适配器模式屏蔽底层实现差异,内置基于 Disruptor 的无锁异步写入,提供可插拔的 Appender 与 Encoder,支持 JSON 编码、MDC 上下文传播、按环境与标签的动态路由及级别过滤,并支持 YAML 配置的热加载与启动校验。

包结构与职责概览:

  • org.toolkit.logging.api:对外日志门面与工厂等公共 API。
  • org.toolkit.logging.core.appender:内置 Appender 实现与相关策略(如文件滚动策略)。
  • org.toolkit.logging.core.encoder:内置编码器实现(JSON、Pattern 等)。
  • org.toolkit.logging.context:MDC 等上下文管理与传播支持。
  • org.toolkit.logging.spi:扩展点绑定与实现发现。
  • org.toolkit.logging.bridge:与外部日志框架的桥接适配。

主要功能

  • 统一日志抽象与桥接
    • 提供 Logger/LoggerFactory 统一 API,屏蔽底层实现差异。
    • 通过桥接模块与主流日志生态互操作,便于增量迁移与统一接入。
  • 高吞吐异步写入
    • 基于 Disruptor 的无锁环形队列进行事件化处理,降低写入端对业务线程的影响。
  • 灵活的编码与格式化
    • 支持 JSON 编码与模式化文本编码,满足日志采集、分析与人读友好等多样需求。
  • MDC 上下文传播
    • 在线程池与 Web 场景中传播 TraceId、用户标识等上下文,确保跨线程一致性。
  • 动态路由与级别过滤
    • 按环境、标签、日志级别等维度路由到不同 Appender;支持细粒度级别阈值控制。
  • 可插拔扩展能力
    • Appender、Encoder 等组件通过 SPI 插拔扩展,便于按需定制与集成第三方实现。
  • 配置管理
    • YAML 配置热加载;启动阶段配置校验,提前发现缺失或不一致配置。
  • 文件归档与滚动
    • 提供文件滚动策略以管理日志文件大小与留存。

核心组件

  • Logger
    • 日志门面,提供按级别记录与结构化参数输出,负责采集 MDC 与标签等上下文并生成日志事件。
  • LoggerFactory
    • 日志工厂,按名称/类型生成与缓存 Logger;在初始化时装配异步分发器、路由策略与已注册扩展。
  • Appender(接口)
    • 日志事件的落地方向抽象,定义追加、启动、关闭等生命周期方法,可挂接编码与过滤逻辑。
  • ConsoleAppender
    • 将日志输出至标准输出/错误输出,适用于开发与容器化运行环境。
  • FileAppender
    • 将日志输出至文件,配合滚动策略进行归档与留存控制。
  • JsonEncoder
    • 将日志事件编码为 JSON 表示,包含时间戳、级别、消息、异常与 MDC/标签等信息。
  • PatternEncoder
    • 基于可配置模式将日志事件格式化为文本,便于人读与兼容传统日志格式。
  • AsyncDispatcher
    • 异步分发器,基于 Disruptor 接收业务线程提交的日志事件并在独立线程中分发至路由/Appender。
  • MdcContext
    • MDC 上下文管理,提供设置/清理 API,并支持在线程池、Web 请求处理链中的上下文传播。
  • SpiBinder
    • 扩展绑定与发现入口,用于注册与装配自定义的 Appender、Encoder 等实现。
  • Slf4jBridge
    • 与 SLF4J 等日志生态进行桥接,支持在现有代码中统一路由到本框架。
  • LogConfig
    • 日志配置模型与加载器,负责从 YAML 读取配置、热加载监听与启动期配置校验。
  • RoutingPolicy
    • 路由策略,依据环境、标签、日志级别等维度选择目标 Appender 集合,实现动态路由与过滤。
  • RollingPolicy
    • 文件滚动策略,定义滚动触发条件与归档命名/留存规则,供 FileAppender 使用。

组件协作流程(简述):

  • 业务代码通过 Logger 记录日志 -> AsyncDispatcher 异步入队 -> RoutingPolicy 按标签/级别/环境选择 Appender -> Appender 使用 Encoder 编码并落地。
  • LoggerFactory 在启动时基于 LogConfig 进行装配,SpiBinder 负责扩展组件的绑定,MdcContext 贯穿事件生成与编码阶段。

技术特性

  • 架构模式
    • SPI 扩展机制与适配器模式解耦 API 与实现;Appender/Encoder 等通过约定接口/契约扩展。
  • 高性能异步
    • 采用 Disruptor 实现无锁环形队列与事件驱动消费,降低锁竞争与 GC 压力,提升高并发写入吞吐。
  • 上下文一致性
    • MDC 跨线程、跨请求传播,确保链路追踪等上下文在异步与回调场景下不丢失。
  • 可插拔与可观测
    • Appender 与 Encoder 可按需增删替换;路由与级别过滤可在不改业务代码的情况下动态调整。
  • 配置治理
    • YAML 配置支持热加载;启动校验覆盖路由目标存在性、级别阈值有效性、滚动策略配置完整性等。
  • 桥接兼容
    • 通过 bridge 模块与现有日志生态互操作,降低迁移成本并避免重复日志。

使用场景

  • 库与组件的统一日志门面
    • 对外仅暴露 api,使用者可在不同运行环境中选择具体实现且保持行为一致。
  • 高吞吐服务端/微服务
    • 通过 AsyncDispatcher 提升写入吞吐并降低对业务线程的影响;使用 JsonEncoder 便于日志采集与分析。
  • 多环境差异化路由
    • 开发环境路由至 ConsoleAppender,生产环境路由至 FileAppender/远端管道;基于标签对关键域进行单独输出。
  • Web 与异步任务
    • 使用 MdcContext 传播 traceId/userId 等,实现端到端链路排障。
  • 渐进式迁移与整合
    • 利用 Slf4jBridge 与现有生态集成,在不改业务代码的情况下统一日志入口。
  • 合规与留存需求
    • 配合 RollingPolicy 管理日志滚动与留存周期,满足审计与合规要求。

示例详情

📖 如何使用

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

✅ 特性总结

一键生成规范化的Java包描述文档,快速补齐新项目与遗留代码的技术说明,降低团队沟通成本。
自动识别包内核心类与接口职责,清晰标注模块边界,帮助新人快速上手与高效协作。
基于包结构梳理上下层关系,直观呈现架构定位与协作方式,支持评审与重构决策。
按统一模板输出概述、功能、组件、特性与场景,让文档可读可维护,轻松纳入知识库。
对输入信息进行一致性校验与措辞优化,自动润色术语与结构,使描述准确可信。
支持多场景文档风格切换,如开源说明、内审材料与技术交接,内容格式一键适配。
从代码层面提炼实现思路与注意事项,避免空话与堆砌,突出可复用点,提升文档实战性。
结合业务目标强调包在系统中的作用与影响,帮助产品与技术对齐预期,减少误解与返工。
输入包名与层级即可开工,免繁琐说明与格式摸索,立刻获得可发布的技术文档草案。
为团队迭代提供统一术语与描述口径,减少评审分歧与沟通成本,缩短交付周期。

🎯 解决的问题

让 AI 以专家视角,把分散的包结构与功能线索在几分钟内转化为清晰、可发布、可复用的标准化包描述;在新项目搭建、遗留系统梳理、开源仓库完善、企业交接与内审等核心场景,帮助团队稳定产出高质量技术说明,提升协作效率与代码可读性;通过固定章节与一致表述降低写作成本和沟通摩擦,形成可持续复用的文档生产力,驱动试用转化与团队级付费部署。

🕒 版本历史

当前版本
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
用户评价与反馈系统,即将上线
倾听真实反馈,在这里留下您的使用心得,敬请期待。
加载中...
📋
提示词复制
在当前页面填写参数后直接复制: