hanbings / cynops

📦 Cynops - 蝾螈

Home Page:https://cynops.tech

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

📦 Cynops Toolbox

Github License GitHub Workflow Status Jenkins Codacy grade Version GitHub Last Commit Blog Blog

🍔 自我介绍:

你好!很高兴遇见你!我的名字叫蝾螈! 我是为了减少搜索频率,增加键盘寿命而生的! 你也可以把我视作一个把各种要频繁搜索的内容放到一起而已,并不是什么认真设计的项目

👷 构建状态:

构建 / Build 状态 / Status
Github Actions GitHub Workflow Status
CI Server Jenkins
Code Check Codacy grade

✨ 功能:

状态 / Status 项目 / Project 功能 / Function 是否为 Java 原生(无依赖)/ No third party dependencies
🍻 cynops-event Event Bus 实现 ✔️
🚧 cynops-extra IO工具 基本类型工具以及扩展基本类型 ✔️
🍻 cynops-cryptos 安全工具 目前是摘要、对称/非对称加密算法的封装 ✔️
🚧 cynops-tool 邮件工具 二维码工具 工具 2FA 工具 一些稀奇古怪的第三方API 送一个下崽器(错乱)
🚧 cynops-auth 常见 OAuth 封装

🚧 正在完成一部分功但未达到可使用程度

🍻 已经开始进行稳定开发且已经可以使用一部分功能

🎯 TODO:

📝 文档:

EventBus 解析:Java实现一个简单的EventBus

🍺 使用:

Cynops 分为两个版本 dev 开发版本和 release 发布版本

release 每一次发布都会同步一次 release 分支 主分支 main 则为最新 dev 版本的代码

无论是 dev 还是 release 都会发布 jar 到私有 maven 仓库

https://repository.hanbings.com/

前往仓库查看需要的版本并引用它即可

🎉 贡献:

欢迎任何人对项目进行贡献! 即使你认为你的水平很低 呜呜呜 没有人会比我还菜了吧

  1. 如果你觉得任何一处的代码烂得不行 请直接发起 issues 或 pr 即可 项目出现的意义就是学习更新的技术和更好的编写方式 而且寒冰的脾气好得很
  2. 尽可能的多一些注释 代码风格贴近 阿里 或 Google
  3. 为了 Github 平台观感更好一些 项目使用大量 emoji 对 commit readme 等进行修饰 请按照下面的表格来修饰 commit 记录

🎨 命名约定:

为了类名 方法名更能被按照正常思维的理解 项目遵循一定的命名约定

  1. 类名大写驼峰 方法名小写驼峰 不使用匈牙利命名法 即类型缩写
  2. 包名全小写 包名类名方法名有需要时使用复数
  3. 优先使用方法重载
  4. 同功能不同参数的方法 优先使用方法重载 如果确实无法进行重载 则在功能后使用 with 连接词 功能 + With + 参数类型
  5. 同功能不同参数也不同返回值 使用 功能 + To + 返回值类型 如 base64ToBytes() 需与上一条规则连用 如 base64WithMimeToBytes() 有时候可能不需要 To 作为连接词能让名字读起来更自然一些 那么就不需要 To 如 byte[] randomDesKeyBytes() 当然 如果无法分辨 优先使用 功能 + To + 返回值类型 格式

About

📦 Cynops - 蝾螈

https://cynops.tech

License:Apache License 2.0


Languages

Language:Java 100.0%