开发指南

开发工具及相关软件

JDK 1.8 + Gradle 6.0 + eclipse-jee-2019-12 + Tomcat 9 + MySQL Server 5.5 + kafka 2.5.0 + Redis 6 + OpenLDAP 2.2 +

程序目录

MaxKey一级目录二级目录三级目录说明
README.md 关于MaxKey项目
LICENSE 许可证
database-sql 版本对应MYSQL
docs 项目网站
gradle gradle的配置
maxkey-authentications 登录认证
maxkey-client-sdk JAVA集成使用SDK
maxkey-connectors 身份供应连接器
maxkey-connector-activedirectory ActiveDirectory连接器
maxkey-connector-base 身份供应连接器接口
maxkey-connector-ldap LDAP连接器
maxkey-connector-dingtalk 钉钉连接器
maxkey-connector-workweixin 企业微信连接器
maxkey-core 基础包
maxkey-dao 数据库访问
maxkey-identitys 身份管理
maxkey-identity-kafka kafka身份同步
maxkey-identity-scim SCIM2.0身份管理
maxkey-lib 使用jar包
maxkey-protocols 认证协议实现
maxkey-protocol-authorize 认证协议实现
maxkey-protocol-cas CAS认证协议实现
maxkey-protocol-desktop 桌面认证实现模拟键盘输入登录
maxkey-protocol-extendapi 扩展API实现
maxkey-protocol-formbased Formbased实现
maxkey-protocol-oauth-2.0 oauth-2.0实现
maxkey-protocol-saml-2.0 saml-2.0实现
maxkey-protocol-tokenbased tokenbased实现
maxkey-web-manage 管理系统
maxkey-web-maxkey 认证系统
shellscript 启动脚本
build.gradle 工程构建及版本控制
gradle.properties 版本参数配置
settings.gradle 项目引入
gradleSetEnv.bat JDK及Gradle路径配置,用于构建脚本,需要开发人员自行配置
gradleBuildClean.bat 清除历史构建版本
gradleBuildRelease.bat 构建新版本
gradleIDEClean.bat 清除IDE的设置
gradleIDETask.bat 设置IDE

工程构建BuildRelease

1. 配置环境变量 gradleSetEnv.bat set JAVA_HOME=D:\JavaIDE\jdk1.8.0_91 set GRADLE_HOME=D:\JavaIDE\gradle-5.4.1 2. 启动构建 gradleBuildRelease.bat 3. 构建结果 构建包路径 MaxKey/build/maxkey-jars 依赖包路径 MaxKey/build/maxkey-depjars

问题及解决

问题1 “A cycle was detected in the build path of project: XXX” 解决方法: Eclipse Menu -> Window -> Preferences... -> Java -> Compiler -> Building -> Building path problems -> Circular dependencies -> 将Error改成Warning 问题2 Access restriction 解决方案: Eclipse Menu -> Window -> Preferences... -> Java -> Compiler -> Errors/Warnings界面的Deprecated and restricted API下。把Forbidden reference (access rules): 的规则由默认的Error改为Warning即可。