hub / github.com/terran4j/commons

github.com/terran4j/commons @v1.0.2

Chat with this repo

repository ↗ · DeepWiki ↗ · release v1.0.2 ↗ · + Follow

2,808 symbols 8,277 edges 331 files 289 documented · 10% 6 cross-repo links

What it actually does AI analysis from the code graph — generated when you open this

loading…

README

项目简介

本项目采用 SpringBoot 框架构建，致力于为 SpringBoot 应用程序的开发提升开发效率及编程体验。

本项目由多个子项目组成，每个子项目聚焦解决一个问题。这里先简单介绍下这些子项目： * commons-api2doc:
简称 Api2Doc，是一款 Http API 文档自动化生成工具，它通过反射的方式，读取 Controller 类的信息，然后自动生成易于阅读的在线 API 文档，节省开发者手工编写 API 文档的工作量。 * commons-restpack:
简称 RestPack，是一款 Http API 数据包装框架，它可以将 Http API 的返回结果包装成统一的报文格式。 * commons-dsql:
简称 DSQL，是一款从 SQL 到对象的自动映射框架，它尤其擅长动态复杂 SQL 的处理。它结合了现在两大主流持久层框架 JPA 及 MyBatis 的优点，从而更进一步的提高了持久层的开发效率。

适用用户

适合有 Java / Kotlin + SpringBoot 开发经验的开发者们使用。

如果您有 Java 开发经验但对Spring Boot 还不熟悉的话，建议先阅读笔者写过的一本书《Spring Boot 快速入门》。这本书的目标是帮助有 Java 开发经验的程序员们快速掌握 Spring Boot 开发技巧，感受到 Spring Boot 的极简开发风格及超爽编程体验。

软件版本

本项目中所用到的基础软件，均基于以下版本构建： * Java: 1.8 * Maven: 3.3.9 * SpringBoot: 1.5.9.RELEASE

本项目及所有子项目均在以上版本测试过，可以正常运行。其它版本理论上相同，应该没啥区别，若遇到问题，欢迎反馈！

Extension points exported contracts — how you extend this code

CacheService (Interface)

key - value 结构的缓存服务接口。具体实现可能有多种，如：本地内存缓存、Redis 分布式缓存等。 @author wei.jiang [6 implementers]

commons-hedis/src/main/java/com/terran4j/commons/hedis/cache/CacheService.java

CommandExecutor (Interface)

@author jiangwei [7 implementers]

commons-jfinger/src/main/java/com/terran4j/commons/jfinger/CommandExecutor.java

ErrorCode (Interface)

@author jiangwei [7 implementers]

commons-util/src/main/java/com/terran4j/commons/util/error/ErrorCode.java

CodeOutput (Interface)

(no doc) [4 implementers]

commons-api2doc/src/main/java/com/terran4j/commons/api2doc/codewriter/CodeOutput.java

RefluxServer (Interface)

连接管理器，用于服务端管理所有的客户端连接通道。注意：暂时只用于服务端，用于服务端向客户端的逆向推送。 TODO: 后续会考虑要不要加上正向推送。 @author wei.jiang [2 implementers]

commons-reflux/src/main/java/com/terran4j/commons/reflux/RefluxServer.java

DsqlExecutor (Interface)

动态 SQL 执行器。 @author jiangwei [2 implementers]

commons-dsql/src/main/java/com/terran4j/commons/dsql/DsqlExecutor.java

HttpAroundHandler (Interface)

@author wei.jiang

commons-restpack/src/main/java/com/terran4j/commons/restpack/HttpAroundHandler.java

HttpClientListener (Interface)

(no doc)

commons-hi/src/main/java/com/terran4j/commons/hi/HttpClientListener.java

Core symbols most depended-on inside this repo

push

called by 466

commons-util/src/main/java/com/terran4j/commons/util/value/ValueSources.java

append

called by 285

commons-api2doc/src/main/java/com/terran4j/commons/api2doc/impl/FlexibleString.java

add

called by 279

commons-util/src/main/java/com/terran4j/commons/util/value/KeyedList.java

get

called by 262

commons-util/src/main/java/com/terran4j/commons/util/value/ValueSource.java

getName

called by 150

commons-util/src/main/java/com/terran4j/commons/util/error/ErrorCode.java

concat

called by 146

commons-util/src/main/java/com/terran4j/commons/util/Arrays.java

isDef

called by 137

commons-website/src/main/resources/static/website/vue/vue-2.5.10.js

size

called by 99

commons-util/src/main/java/com/terran4j/commons/util/value/KeyedList.java

Shape

Method 1,558

Function 922

Class 288

Interface 22

Enum 18

Languages

Java67%

TypeScript33%

Modules by API surface

commons-website/src/main/resources/static/website/vue/vue-2.5.10.js411 symbols

commons-website/src/main/resources/static/website/vue/vue-2.5.10.min.js314 symbols

commons-website/src/main/resources/static/website/jquery/jquery-3.3.1.min.js92 symbols

commons-website/src/main/resources/static/website/less/less-1.7.0.js61 symbols

commons-api2doc/src/test/java/com/terran4j/test/api2doc/ApiResultObjectTest.java39 symbols

commons-api2doc/src/main/java/com/terran4j/commons/api2doc/codewriter/RetrofitCodeWriter.java26 symbols

commons-website/src/main/resources/static/website/element-ui/element-ui.min.js24 symbols

commons-restpack/src/test/java/com/terran4j/test/restpack/RestPackTest.java22 symbols

commons-api2doc/src/main/java/com/terran4j/commons/api2doc/domain/ApiDocObject.java21 symbols

commons-restpack/src/main/java/com/terran4j/commons/restpack/HttpResult.java20 symbols

commons-jfinger/src/main/java/com/terran4j/commons/jfinger/impl/BackCommandException.java20 symbols

commons-api2doc/src/test/java/com/terran4j/test/api2doc/Api2DocObjectFactoryTest.java20 symbols

Used by 6 indexed graphs manifest dependencies, hub-wide

github.com/TriliumNext/Trilium

github.com/aws-powertools/powertools-lambda-typescript

github.com/feathersjs/feathers

github.com/iflytek/astron-agent

github.com/mockoon/mockoon

github.com/sinonjs/sinon

Datastores touched

(mysql)Database · 1 repos

For agents

$ claude mcp add commons \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact