# MagicTool

**Repository Path**: pbyang1995/MagicTool

## Basic Information

- **Project Name**: MagicTool
- **Description**: 一个JavaWeb工具。
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2018-06-02
- **Last Updated**: 2021-11-02

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

#MagicTool的自我介绍
    我将渗入你们的点滴。

#模块简述
    缓存: 默认提供ehcache和redis缓存，其它缓存请扩展
    验证码: 验证码生成和验证，默认保存在ehcache中，若分布式请保存在redis中，或者使用扩展化缓存，若内置验证码不合心意，请扩展验证码模块实现自定义
    配置文件: MagicTool的全局配置文件，所有模块配置都通过该配置文件读取
    加密解密: 常用的加密解密方式，对称，非对称
    异常: MagicTool全局异常，采用错误码+错误信息的方式展示异常
    网络请求: 对网络请求进行了封装，让他的使用变得简单便捷
    配置资源: 读取配置文件的工具类，支持properties、xml、yaml三种配置的读取，并且支持读取程序外部配置文件
    日志: 使用日志更为简单，全静态使用日志
    信息: 包含一个邮件系统
    工具包: 常用工具类，StringUtils， IdGen等等工具类

#包结构

com.hong610.magic.tool: 主包

    cache: 缓存
        ehcache: EhCache缓存相关
        redis: Redis缓存相关
    
    captch: 验证码
        config: 验证码配置文件
        util: 验证码工具包
        web: 验证码Web端
    
    config: 配置文件
    
    encryp: 加密解密
    
    exception: 异常
    
    http: 网络请求
        core: Http的具体操作
    
    logger: 日志
        config: 日志配置文件
    
    message: 信息
        email: 邮件模块
    
    resources: 配置资源
        resources: Properties配置文件
        yaml: Yaml配置文件
    
    util: 工具包
    
#扩展接口及使用
    缓存扩展: 实现com.hong610.magic.tool.cache.Cache接口
        可使用模块: 
            验证码: mt.properties中mt.maptcha.cache配置
            
    验证码扩展: 实现com.hong610.magic.tool.captcha.Captcha接口
        可使用模块: 
            验证码: mt.properties中mt.maptcha.extend.class配置
            
    日志扩展: 实现com.hong610.magic.tool.logger.Logger接口
        可使用模块: 
            日志: mt.properties中mt.logger.class配置
            
    消息扩展: 实现com.hong610.magic.tool.message.Message接口
        可使用模块: 
            消息: com.hong610.magic.tool.message.MessageFactory.get("包路径")