3 Star 5 Fork 2

needcoke/coke

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

coke : a java ioc foundation framework


📚简介

coke是一个类springboot的ioc框架,与之不同的是coke更为简单,纯粹。在使用方式上coke继承了springboot的简单易用,在框架本身上对开发者更加友好,是真正拥抱自定义框架的开发者的。

coke仅仅102KB大小,小型项目。由于其在预加载,容器后置处理上采用异步方案,使其相较于springboot项目拥有更快的启动速度。

coke拥有丰富的官方扩展包,🌎coke-extend项目


🎁coke适合哪些项目

  • 1、对框架国产化有要求的项目
  • 2、对包体积有要求的场景
  • 3、高启动速度、低web延迟项目
  • 4、轻量级项目或demo
  • 5、java脚本

📦安装

🍊Maven

在项目的pom.xml的dependencies中加入以下内容:


<dependency>
    <groupId>io.gitee.needcoke</groupId>
    <artifactId>coke</artifactId>
    <version>1.0.2-RELEASE</version>
</dependency>

🍐Gradle

implementation group: 'io.gitee.needcoke', name: 'coke', version: '1.0.2-RELEASE'

📦使用文档

🚚1、启动类

🌎示例项目 使用coke框架必须要在启动类中按照如下格式书写,以RunApplication类为例:

public class RunApplication {

    public static void main(String[] args) {
        CokeApplication.run(RunApplication.class, args);
    }
}

🚚2、常用注解

🌎示例项目

🚗2.1 @Component

  • a、@Component注解用于定义一个组件bean,该注解作用在类上。
  • b、coke启动时会为@Component类创建一个单例bean。
  • c、通过@Component的value属性或者name属性可以修改bean在容器中的名称(唯一标识),name属性的优先级高于value。 如果不为name和value赋值,则coke会为该bean赋默认名称,类名首字母首字母小写,该场景下(coke自动分配)如果名称与其他bean重复则会加上@符加六位随机字符。手动分配场景出现名称重复会直接报错。

参考如下:

import pers.warren.ioc.annotation.Component;

//@Component(name = "userService")
//@Component("userService")
@Component
public class UserService {

    public void sayHello(){
        System.out.println("hello coke");
    }
}

🚗2.2 @Configuration

  • a、@Configuration注解定义一个配置bean,该注解作用在类上。
  • b、coke启动时会为@Configuration类创建一个单例bean。
  • c、通过@Configuration的value属性或者name属性可以修改bean在容器中的名称(唯一标识),name属性的优先级高于value。 如果不为name和value赋值,则coke会为该bean赋默认名称,类名首字母首字母小写,该场景下(coke自动分配)如果名称与其他bean重复则会加上@符加六位随机字符。手动分配场景出现名称重复会直接报错。

注:@Configuration所生成的bean在生成顺序上理论优先于@Component


🚗2.3 @Value

@Value注解可以在bean中注入配置文件的配置。coke支持注入的配置文件包括: 启动命令行参数,环境变量,application.yaml,application.yml,application.properties,优先级从高到低。

配置文件示例:

properties:
  demo: hello coke
  demo2: 233

注入配置文件示例:

import pers.warren.ioc.annotation.Configuration;
import pers.warren.ioc.annotation.Value;

@Configuration
public class CokeConfig {

    @Value("properties.demo")
    private String demo;

    @Value("properties.demo2")
    private String demo2;

    @Value("properties.demo3:666")        //如果配置文件中找不到 properties.demo3对应的值,则赋予该字段默认值 666
    private String demo3;
}

🚗2.4 @Bean

  • a、@Bean用于定义一个简单bean,作用在方法上(该方法必须是@Component或@Configuration标注的类中的方法)
  • b、coke启动时会为@Bean类创建一个单例bean。
  • c、生成的bean的名称默认会使用@bean所标注的方法名,也可以通过@Bean的name属性手动分配。 coke自动分配名称,如果名称与其他bean重复则会加上@符加六位随机字符。手动分配场景出现名称重复会直接报错。

示例如下:

import com.hello.coke.cp.User;
import pers.warren.ioc.annotation.Bean;
import pers.warren.ioc.annotation.Configuration;

@Configuration
public class CokeConfig {

    @Bean(name = "userDemo2")
    public User userDemo(){
        return new User();
    }
}

🚗2.5 @Autowired

通过@Autowired可以在一个bean中注入另一个bean。该注解作用于属性,setter方法和构造函数上。

示例:

import com.hello.coke.config.CokeConfig;
import pers.warren.ioc.annotation.Autowired;
import pers.warren.ioc.annotation.Component;

@Component
public class UserService {

    @Autowired("userDemo2")
    private User user;

    @Autowired
    private CokeConfig config;

    private Integer max;

    @Autowired
    public void setMax(Integer max) {
        this.max = max;
    }
    public void sayHello(){
        System.out.println(user.getName() + "hello" + hashCode());
        System.out.println(config.toString());
    }
}

🍉3、获取bean

  • 1、通过@Autowired注入
  • 2、通过@Resource注入
  • 3、通过ApplicationContext.getBean(xxx)
import com.hello.coke.cp.User;
import pers.warren.ioc.CokeApplication;
import pers.warren.ioc.annotation.Autowired;
import pers.warren.ioc.annotation.Component;
import pers.warren.ioc.core.ApplicationContext;

import javax.annotation.Resource;
import java.nio.file.attribute.UserDefinedFileAttributeView;

/**
 * 启动类
 */
@Component  //增加该注解,可以在启动类中注入需要使用的bean
public class RunApplication {

    @Autowired
    private static User user;

    @Resource
    private static User userDemo;

    public static void main(String[] args) {
        ApplicationContext applicationContext = CokeApplication.run(RunApplication.class, args);   //获取coke容器上下文
        User user1 = applicationContext.getBean("user");          //获取bean
        User user2 = applicationContext.getBean(User.class);      //获取bean
    }
}

4、详细文档

📥下载jar

🌎下载页面

🏗️添砖加瓦

coke开发者QQ群聊169208957,期待你的加入!

🧬贡献代码的步骤

    1. 在Gitee或者Github上fork项目到自己的repo
    1. 把fork过去的项目也就是你的项目clone到你的本地
    1. 修改代码(记得一定要修改develop分支)
    1. commit后push到自己的库(develop分支)
    1. 登录Gitee或Github在你首页可以看到一个 pull request 按钮,点击它,填写一些说明信息,然后提交即可。
    1. 等待维护者合并
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

java ioc框架示范 拥有完整的容器生命周期,bean生命周期的生产级框架。支持引入web,aop,数据库,redis,消息中间件,bus等等。具有比spring更优秀的扩展能力 展开 收起
Java
Apache-2.0
取消

发行版 (1)

全部

贡献者

全部

近期动态

加载更多
不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
Java
1
https://gitee.com/needcoke/coke.git
git@gitee.com:needcoke/coke.git
needcoke
coke
coke
develop

搜索帮助

Dd8185d8 1850385 E526c682 1850385