# TODAY Framework **Repository Path**: I-TAKE-TODAY/today-framework ## Basic Information - **Project Name**: TODAY Framework - **Description**: 你问我优雅的代码长啥样？那我得好好展示一番！ - **Primary Language**: Java - **License**: GPL-3.0 - **Default Branch**: master - **Homepage**: https://taketoday.cn/articles/1565195388947.html - **GVP Project**: No ## Statistics - **Stars**: 15 - **Forks**: 5 - **Created**: 2018-04-12 - **Last Updated**: 2026-01-04 ## Categories & Tags **Categories**: ioc-framework **Tags**: None ## README # TODAY Infrastructure ![Logo](./logo.svg) A Java library for applications software infrastructure. ![Java17](https://img.shields.io/badge/JDK-17+-success.svg) [![GPLv3](https://img.shields.io/badge/License-GPLv3-blue.svg)](./LICENSE) [![Deploy](https://github.com/TAKETODAY/today-infrastructure/actions/workflows/deploy-snapshots.yml/badge.svg)](https://github.com/TAKETODAY/today-infrastructure/actions/workflows/deploy-snapshots.yml) [![Codecov](https://github.com/TAKETODAY/today-infrastructure/actions/workflows/codecov.yaml/badge.svg)](https://github.com/TAKETODAY/today-infrastructure/actions/workflows/codecov.yaml) [![Coveralls](https://github.com/TAKETODAY/today-infrastructure/actions/workflows/coveralls.yaml/badge.svg)](https://github.com/TAKETODAY/today-infrastructure/actions/workflows/coveralls.yaml) [![CI](https://github.com/TAKETODAY/today-infrastructure/actions/workflows/ci.yaml/badge.svg)](https://github.com/TAKETODAY/today-infrastructure/actions/workflows/ci.yaml) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/3ad5eed64065496fba9244d149820f67)](https://app.codacy.com/gh/TAKETODAY/today-infrastructure/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) [![Coverage Status](https://codecov.io/gh/TAKETODAY/today-infrastructure/branch/master/graph/badge.svg?token=OUMKSYNTDC)](https://codecov.io/gh/TAKETODAY/today-infrastructure) [![Coverage Status](https://coveralls.io/repos/github/TAKETODAY/today-infrastructure/badge.svg)](https://coveralls.io/github/TAKETODAY/today-infrastructure) [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FTAKETODAY%2Ftoday-infrastructure.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2FTAKETODAY%2Ftoday-infrastructure?ref=badge_shield) **You ask me what the elegant code looks like? Then I have to show it!** ## 主要目的 主要为了学习技术，顺便给自己的博客网站 https://taketoday.cn 提供基础框架（其实写的博客网站也是为了学习练习技术）。博客也开源了：https://github.com/TAKETODAY/today-blog
点击查看背景 ## 背景 起源于大学的时候学习编程，后来用 Java Servlet 做了一个博客网站。在开发过程中发现有很多重复代码， 我觉得这样的代码很不优雅，尽管那个时候刚学编程不久，于是在我学习 [Struts2](https://struts.apache.org/) 的时候自己尝试着写了一个类似的 通过 `XML` 配置干掉了大量的重复代码的程序。于是初代的 [today-web](https://gitee.com/I-TAKE-TODAY/today-web/tree/v1.1.1/) 诞生并开源。 后面学习了 `Java 注解` 又实现了通过注解配置的版本 [today-web 注解版](https://gitee.com/I-TAKE-TODAY/today-web/tree/2.1.x/) [today-web 注解版](https://gitee.com/I-TAKE-TODAY/today-web/tree/2.1.x/) 刚出来时也正在学 `Spring` 感觉没有 `IoC` 容器感觉不是很方便。在网上看到很多自己写 什么 Mini Spring 之类，所以我大胆决定`我也要写一个`。有这个决心是因为我把 today-web 都写出来了， 再写个 IoC 应该不难吧。刚开始参考了各种 mini-spring，该说不说现在看来正是那个时候参考了他们的代码才导致我有些认知错误。在2021年6月-2021年12月期间 又去深入看 Spring 源码才纠正过来。事实证明写一个这样的东西确实不难，只是要优雅的话还是要点东西的。我自认为我的代码还是优雅的。不信？ [我的B站直播间欢迎你](https://live.bilibili.com/22702726) 。（在2021年开始直播写这个库，后面工作比较忙了就没怎么直播，后面有时间就会直播）。 刚开始写的时候（大概是2018年,我也是看的Git提交记录哈哈）有点无从下手，所以我去参考上文说到的各类 `Mini Spring`。 就这样又开启了一轮学习。 学习如何扫描类文件、学习Java注解、Java字节码、动态代理、重新认识接口、一些设计模式、学习使用Git、渐渐明白了单元测试的重要性 等。随着学习的深入框架经历了数次重构，自己也对依赖注入有了自己的看法。慢慢的我发现我居然能看得明白 Spring 源码了。 感觉Spring真心强大。 如果你问我怎么学习编程，我觉得造轮子是比较好的方式。自己还有很多要学的东西。比如分布式方面的知识，所以今后你定会看到诸如 [today-rpc](https://github.com/TAKETODAY/today-rpc), `today-distributed-*` 等项目诞生。 ## 现状 学习维护一个项目，这是一个长久的过程。 在 2021 年随着学习的深入我觉得 Spring 功能强大，设计良好，自己虽然也能设计一些类似的功能，但是始终觉得靠我一个人的力量是不能设计 这么多完善的，于是我打算换种方式学习：移植。再转向到了现在这种学习方式：维护（通过维护学习新东西）。移植也不是一个简单的过程，不是单纯的 复制粘贴，我要结合之前的代码把 Spring 的代码适配到我原有的工程体系中，加之之前我的很多模块都是单独的 Git 仓库，我还要将他们合并到一个仓库。 我是一个模块一个模块的开始，一个模块我会学到很多东西。 这个过程持续了 2 年多（可以从 Git 提交记录看到）。后续的 Spring 主分支更新我也一直在同步（BUG 修复，新功能）。 在这期间我发现了 Spring 的一些问题，针对其中的一部分我还给 [Spring](https://github.com/spring-projects/spring-framework) 提交过多次优化改进的 PR。 这个库目前只有我在自己的生产环境使用，移植的模块是根据我自己的一些项目使用情况来的，例如没有移植 JMS, Messaging, R2dbc, Web Flux。 有些是我觉得没必要封装有的功能是我还没使用上。 ```text 截止: f72a88a9e72f86a28b96a4e46dc684a20ad8762f cloc ./ 11926 text files. 11400 unique files. 958 files ignored. github.com/AlDanial/cloc v 2.04 T=27.43 s (415.6 files/s, 61331.5 lines/s) ---------------------------------------------------------------------------------------- Language files blank comment code ---------------------------------------------------------------------------------------- Java 9570 221822 455007 889459 AsciiDoc 355 11685 844 39546 XML 675 3005 3541 20370 Text 68 1858 0 7997 Gradle 233 1050 357 5169 XSD 17 277 223 4118 SQL 54 49 52 2227 JSON 34 1 0 2219 HTML 34 400 210 1999 YAML 61 102 14 985 Properties 210 93 560 897 Markdown 4 232 4 894 SVG 2 2 17 617 DTD 3 156 548 521 Bourne Shell 3 84 354 311 AspectJ 9 102 449 266 Bourne Again Shell 1 37 58 229 diff 5 47 176 221 DOS Batch 3 63 6 212 Groovy 16 54 4 126 Maven 5 17 35 121 XSLT 8 23 1 94 Freemarker Template 5 4 4 37 JSP 4 3 0 35 CSS 6 3 0 15 JavaScript 7 1 0 12 Protocol Buffers 1 2 0 11 INI 1 5 0 8 Mustache 1 0 0 8 Python 1 1 0 4 Velocity Template Language 4 0 0 4 ---------------------------------------------------------------------------------------- SUM: 11400 241178 462464 978732 ---------------------------------------------------------------------------------------- ```
## 🛠️ 安装 ### Gradle 推荐方式：[buildSrc/build.gradle](infra-samples/buildSrc/build.gradle) ```groovy plugins { id 'java-gradle-plugin' } repositories { mavenLocal() maven { url = "https://central.sonatype.com/repository/maven-snapshots/" } mavenCentral() gradlePluginPortal() } dependencies { implementation(platform("cn.taketoday:infra-bom:$infraVersion")) implementation "cn.taketoday:infra-gradle-plugin" } ``` 以上配置在 IDEA 里有代码提示。下面的配置则没有。 一般项目：[settings.gradle](./infra-samples/settings.gradle) ```groovy buildscript { repositories { mavenLocal() maven { url = "https://central.sonatype.com/repository/maven-snapshots/" } mavenCentral() } dependencies { classpath "cn.taketoday:infra-gradle-plugin:$infraVersion" } } ``` 以上两种配置用一种即可。 子模块 [build.gradle](./infra-samples/build.gradle) 使用了上面的任何一种配置之后子模块就可以使用 `apply plugin: 'infra.application'` 来引入 Gradle 插件 ```groovy apply plugin: "java" apply plugin: 'infra.application' repositories { mavenLocal() maven { url "https://central.sonatype.com/repository/maven-snapshots/" } maven { url "https://maven.aliyun.com/repository/public" } mavenCentral() } dependencies { implementation 'cn.taketoday:ip2region-java:1.0-SNAPSHOT' implementation 'cn.taketoday:today-starter-netty' implementation 'cn.taketoday:today-starter-web' } ``` 具体工程可以参见 [infra-samples](./infra-samples) ### Maven ```xml cn.taketoday today-starter-web ${infraVersion} cn.taketoday today-starter-netty ${infraVersion} ``` ## 开始 ```java @Slf4j @RestController @InfraApplication public class DemoApplication { public static void main(String[] args) { Application.run(DemoApplication.class, args); } @GET("/index") public String index() { return "Hello"; } @GET("/body/{name}/{age}") public Body body(String name, int age) { return new Body(name, age); } @GET("/publish-event") public void index(String name, @Autowired ApplicationEventPublisher publisher) { publisher.publishEvent(new MyEvent(name)); } @GET("/request-context") public String context(RequestContext context) { String requestURL = context.getRequestURL(); String queryString = context.getQueryString(); System.out.println(requestURL); System.out.println(queryString); return queryString; } record Body(String name, int age) { } @Configuration static class AppConfig { @EventListener(MyEvent.class) public void event(MyEvent event) { log.info("event :{}", event); } } record MyEvent(String name) { } @ExceptionHandler(Throwable.class) public void throwable(Throwable throwable) { throwable.printStackTrace(); } } ``` ## 🙏 鸣谢 本项目的诞生离不开以下项目： * [Spring](https://github.com/spring-projects/spring-framework): Spring Framework * [Spring Boot](https://github.com/spring-projects/spring-boot): Spring Boot * [Jetbrains](https://www.jetbrains.com/?from=https://github.com/TAKETODAY/today-infrastructure): 感谢 Jetbrains 提供免费开源授权 ## 📄 开源协议 使用 [GPLv3](https://github.com/TAKETODAY/today-infrastructure/blob/master/LICENSE) 开源协议 [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FTAKETODAY%2Ftoday-infrastructure.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2FTAKETODAY%2Ftoday-infrastructure?ref=badge_large)