gitee
/
roses
mirror of https://gitee.com/stylefeng/roses
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

【8.0】【event】初始化event模块

pull/57/head
fengshuonan 2023-07-14 15:40:10 +08:00
parent 5e9b83d616
commit e5169fb2a0
20 changed files with 634 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
kernel-d-event/README.md Normal file
View File

@ -0,0 +1 @@
# 业务事件

1
kernel-d-event/event-api/README.md Normal file
View File

@ -0,0 +1 @@
# api模块，存放接口、常量、异常、枚举等模块规则相关类

37
kernel-d-event/event-api/pom.xml Normal file
View File

@ -0,0 +1,37 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>cn.stylefeng.roses</groupId>
<artifactId>kernel-d-event</artifactId>
<version>8.0.0</version>
<relativePath>../pom.xml</relativePath>
</parent>
<artifactId>event-api</artifactId>
<packaging>jar</packaging>
<dependencies>
<!--config模块的api-->
<dependency>
<groupId>cn.stylefeng.roses</groupId>
<artifactId>config-api</artifactId>
<version>${roses.version}</version>
</dependency>
<!--参数校验模块-->
<!--用在控制器，参数校验-->
<dependency>
<groupId>cn.stylefeng.roses</groupId>
<artifactId>validator-api</artifactId>
<version>${roses.version}</version>
</dependency>
</dependencies>
</project>

50
kernel-d-event/event-api/src/main/java/cn/stylefeng/roses/kernel/event/api/annotation/BusinessListener.java Normal file
View File

@ -0,0 +1,50 @@
/*
* Copyright [2020-2030] [https://www.stylefeng.cn]
*
* 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.
*
* Guns采用APACHE LICENSE 2.0开源协议，您在使用过程中，需要注意以下几点：
*
* 1.请不要删除和修改根目录下的LICENSE文件。
* 2.请不要删除和修改Guns源码头部的版权声明。
* 3.请保留源码和相关描述文件的项目出处，作者声明等。
* 4.分发源码时候，请注明软件出处 https://gitee.com/stylefeng/guns
* 5.在修改包名，模块名称，项目代码等时，请注明软件出处 https://gitee.com/stylefeng/guns
* 6.若您的项目无法满足以上几点，可申请商业授权
*/
package cn.stylefeng.roses.kernel.event.api.annotation;
import java.lang.annotation.*;
/**
* 业务事件监听的注解
*
* @author fengshuonan
* @since 2023/7/14 15:12
*/
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
public @interface BusinessListener {
/**
* 监听业务的编码或者标识
*/
String businessCode() default "";
/**
* 业务数据的参数类型
*/
Class<?> clazz();
}

45
kernel-d-event/event-api/src/main/java/cn/stylefeng/roses/kernel/event/api/constants/EventConstants.java Normal file
View File

@ -0,0 +1,45 @@
/*
* Copyright [2020-2030] [https://www.stylefeng.cn]
*
* 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.
*
* Guns采用APACHE LICENSE 2.0开源协议，您在使用过程中，需要注意以下几点：
*
* 1.请不要删除和修改根目录下的LICENSE文件。
* 2.请不要删除和修改Guns源码头部的版权声明。
* 3.请保留源码和相关描述文件的项目出处，作者声明等。
* 4.分发源码时候，请注明软件出处 https://gitee.com/stylefeng/guns
* 5.在修改包名，模块名称，项目代码等时，请注明软件出处 https://gitee.com/stylefeng/guns
* 6.若您的项目无法满足以上几点，可申请商业授权
*/
package cn.stylefeng.roses.kernel.event.api.constants;
/**
* 业务事件业务
*
* @author fengshuonan
* @date 2023-07-14 15:05:54
*/
public interface EventConstants {
/**
* 业务事件模块名称
*/
String EVENT_MODULE_NAME = "kernel-s-event";
/**
* 异常枚举的步进值
*/
String EVENT_EXCEPTION_STEP_CODE = "99";
}

33
kernel-d-event/event-api/src/main/java/cn/stylefeng/roses/kernel/event/api/enums/DemoEnum.java Normal file
View File

@ -0,0 +1,33 @@
package cn.stylefeng.roses.kernel.event.api.enums;
import lombok.Getter;
/**
* 一个示例
*
* @author fengshuonan
* @date 2023-07-14 15:05:54
*/
@Getter
public enum DemoEnum {
/**
* markdown格式
*/
MARKDOWN(1, "markdown格式"),
/**
* 富文本格式
*/
TEXT(2, "富文本格式");
private final Integer code;
private final String message;
DemoEnum(Integer code, String message) {
this.code = code;
this.message = message;
}
}

48
kernel-d-event/event-api/src/main/java/cn/stylefeng/roses/kernel/event/api/exception/EventException.java Normal file
View File

@ -0,0 +1,48 @@
/*
* Copyright [2020-2030] [https://www.stylefeng.cn]
*
* 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.
*
* Guns采用APACHE LICENSE 2.0开源协议，您在使用过程中，需要注意以下几点：
*
* 1.请不要删除和修改根目录下的LICENSE文件。
* 2.请不要删除和修改Guns源码头部的版权声明。
* 3.请保留源码和相关描述文件的项目出处，作者声明等。
* 4.分发源码时候，请注明软件出处 https://gitee.com/stylefeng/guns
* 5.在修改包名，模块名称，项目代码等时，请注明软件出处 https://gitee.com/stylefeng/guns
* 6.若您的项目无法满足以上几点，可申请商业授权
*/
package cn.stylefeng.roses.kernel.event.api.exception;
import cn.hutool.core.util.StrUtil;
import cn.stylefeng.roses.kernel.event.api.constants.EventConstants;
import cn.stylefeng.roses.kernel.rule.exception.AbstractExceptionEnum;
import cn.stylefeng.roses.kernel.rule.exception.base.ServiceException;
/**
* 业务事件异常
*
* @author fengshuonan
* @date 2023-07-14 15:05:54
*/
public class EventException extends ServiceException {
public EventException(AbstractExceptionEnum exception, Object... params) {
super(EventConstants.EVENT_MODULE_NAME, exception.getErrorCode(), StrUtil.format(exception.getUserTip(), params));
}
public EventException(AbstractExceptionEnum exception) {
super(EventConstants.EVENT_MODULE_NAME, exception);
}
}

61
kernel-d-event/event-api/src/main/java/cn/stylefeng/roses/kernel/event/api/exception/enums/EventExceptionEnum.java Normal file
View File

@ -0,0 +1,61 @@
/*
* Copyright [2020-2030] [https://www.stylefeng.cn]
*
* 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.
*
* Guns采用APACHE LICENSE 2.0开源协议，您在使用过程中，需要注意以下几点：
*
* 1.请不要删除和修改根目录下的LICENSE文件。
* 2.请不要删除和修改Guns源码头部的版权声明。
* 3.请保留源码和相关描述文件的项目出处，作者声明等。
* 4.分发源码时候，请注明软件出处 https://gitee.com/stylefeng/guns
* 5.在修改包名，模块名称，项目代码等时，请注明软件出处 https://gitee.com/stylefeng/guns
* 6.若您的项目无法满足以上几点，可申请商业授权
*/
package cn.stylefeng.roses.kernel.event.api.exception.enums;
import cn.stylefeng.roses.kernel.event.api.constants.EventConstants;
import cn.stylefeng.roses.kernel.rule.constants.RuleConstants;
import cn.stylefeng.roses.kernel.rule.exception.AbstractExceptionEnum;
import lombok.Getter;
/**
* 业务事件的异常枚举
*
* @author fengshuonan
* @date 2023-07-14 15:05:54
*/
@Getter
public enum EventExceptionEnum implements AbstractExceptionEnum {
/**
* 查询不到对应业务事件
*/
CANT_FIND_EVENT(RuleConstants.BUSINESS_ERROR_TYPE_CODE + EventConstants.EVENT_EXCEPTION_STEP_CODE + "01", "查询不到对应业务事件，具体信息：{}");
/**
* 错误编码
*/
private final String errorCode;
/**
* 提示用户信息
*/
private final String userTip;
EventExceptionEnum(String errorCode, String userTip) {
this.errorCode = errorCode;
this.userTip = userTip;
}
}

1
kernel-d-event/event-sdk/README.md Normal file
View File

@ -0,0 +1 @@
# SDK模块，存放一些本模块通用的工具处理类等

29
kernel-d-event/event-sdk/pom.xml Normal file
View File

@ -0,0 +1,29 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>cn.stylefeng.roses</groupId>
<artifactId>kernel-d-event</artifactId>
<version>8.0.0</version>
<relativePath>../pom.xml</relativePath>
</parent>
<artifactId>event-sdk</artifactId>
<packaging>jar</packaging>
<dependencies>
<!--业务事件api-->
<dependency>
<groupId>cn.stylefeng.roses</groupId>
<artifactId>event-api</artifactId>
<version>${roses.version}</version>
</dependency>
</dependencies>
</project>

107
kernel-d-event/event-sdk/src/main/java/cn/stylefeng/roses/kernel/event/sdk/EventAnnotationScanner.java Normal file
View File

@ -0,0 +1,107 @@
/*
* Copyright [2020-2030] [https://www.stylefeng.cn]
*
* 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.
*
* Guns采用APACHE LICENSE 2.0开源协议，您在使用过程中，需要注意以下几点：
*
* 1.请不要删除和修改根目录下的LICENSE文件。
* 2.请不要删除和修改Guns源码头部的版权声明。
* 3.请保留源码和相关描述文件的项目出处，作者声明等。
* 4.分发源码时候，请注明软件出处 https://gitee.com/stylefeng/guns
* 5.在修改包名，模块名称，项目代码等时，请注明软件出处 https://gitee.com/stylefeng/guns
* 6.若您的项目无法满足以上几点，可申请商业授权
*/
package cn.stylefeng.roses.kernel.event.sdk;
import cn.stylefeng.roses.kernel.event.api.annotation.BusinessListener;
import cn.stylefeng.roses.kernel.event.sdk.pojo.BusinessListenerDetail;
import cn.stylefeng.roses.kernel.rule.util.AopTargetUtils;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.config.BeanPostProcessor;
import java.lang.reflect.Method;
import java.util.ArrayList;
/**
* 扫描所有的业务监听事件，最终汇总到Event容器中
*
* @author fengshuonan
* @since 2023/7/14 15:09
*/
@Slf4j
public class EventAnnotationScanner implements BeanPostProcessor {
@Override
public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {
return bean;
}
@Override
public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
// 如果controller是代理对象,则需要获取原始类的信息
Object aopTarget = AopTargetUtils.getTarget(bean);
if (aopTarget == null) {
aopTarget = bean;
}
Class<?> clazz = aopTarget.getClass();
// 判断类中是否有@BusinessListener注解
this.doScan(clazz, beanName);
return bean;
}
/**
* 扫描整个类中包含的所有@BusinessListener注解
*
* @author fengshuonan
* @since 2023/7/14 15:24
*/
private void doScan(Class<?> clazz, String beanName) {
ArrayList<BusinessListenerDetail> businessListenerDetails = new ArrayList<>();
Method[] declaredMethods = clazz.getDeclaredMethods();
for (Method declaredMethod : declaredMethods) {
BusinessListener businessListener = declaredMethod.getAnnotation(BusinessListener.class);
if (businessListener != null) {
BusinessListenerDetail businessListenerDetail = createDefinition(beanName, declaredMethod, businessListener);
if (businessListenerDetail != null) {
businessListenerDetails.add(businessListenerDetail);
}
log.debug("扫描到资源: " + businessListenerDetail);
}
}
}
/**
* 讲扫描到的注解信息的调用信息，封装到BusinessListenerDetail
*
* @author fengshuonan
* @since 2023/7/14 15:27
*/
private BusinessListenerDetail createDefinition(String beanName, Method method, BusinessListener businessListener) {
return new BusinessListenerDetail();
}
}

44
kernel-d-event/event-sdk/src/main/java/cn/stylefeng/roses/kernel/event/sdk/container/EventContainer.java Normal file
View File

@ -0,0 +1,44 @@
package cn.stylefeng.roses.kernel.event.sdk.container;
import cn.stylefeng.roses.kernel.event.sdk.pojo.BusinessListenerDetail;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
* 事件的容器
*
* @author fengshuonan
* @since 2023/7/14 15:08
*/
public class EventContainer {
/**
* key是业务的标识，例如：ORG_ADD
* <p>
* value是对应监听这个事件的所有方法信息
*/
private static final Map<String, List<BusinessListenerDetail>> CONTEXT = new HashMap<>();
/**
* 获取业务对应的所有监听器
*
* @author fengshuonan
* @since 2023/7/14 15:21
*/
public static List<BusinessListenerDetail> getListener(String businessCode) {
return CONTEXT.get(businessCode);
}
/**
* 添加到容器中业务监听器信息
*
* @author fengshuonan
* @since 2023/7/14 15:22
*/
public static void addListenerList(String businessCode, List<BusinessListenerDetail> businessListenerItemList) {
CONTEXT.put(businessCode, businessListenerItemList);
}
}

26
kernel-d-event/event-sdk/src/main/java/cn/stylefeng/roses/kernel/event/sdk/pojo/BusinessListenerDetail.java Normal file
View File

@ -0,0 +1,26 @@
package cn.stylefeng.roses.kernel.event.sdk.pojo;
import lombok.Data;
import java.lang.reflect.Method;
/**
* 业务事件监听的详情封装
*
* @author fengshuonan
* @since 2023/7/14 15:18
*/
@Data
public class BusinessListenerDetail {
/**
* Spring的Bean名称
*/
private String beanName;
/**
* 业务监听器对应注解的类方法
*/
private Method listenerMethod;
}

42
kernel-d-event/event-sdk/src/main/java/cn/stylefeng/roses/kernel/event/sdk/publish/BusinessEventPublisher.java Normal file
View File

@ -0,0 +1,42 @@
package cn.stylefeng.roses.kernel.event.sdk.publish;
import cn.hutool.extra.spring.SpringUtil;
import cn.stylefeng.roses.kernel.event.sdk.container.EventContainer;
import cn.stylefeng.roses.kernel.event.sdk.pojo.BusinessListenerDetail;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.util.List;
public class BusinessEventPublisher {
/**
* 发布一个业务事件
*
* @author fengshuonan
* @since 2023/7/14 15:37
*/
public static <T> void publishEvent(String businessCode, T businessObject) {
List<BusinessListenerDetail> listener = EventContainer.getListener(businessCode);
for (BusinessListenerDetail businessListenerDetail : listener) {
String beanName = businessListenerDetail.getBeanName();
Method listenerMethod = businessListenerDetail.getListenerMethod();
Object bean = SpringUtil.getBean(beanName);
try {
listenerMethod.invoke(bean, businessObject);
} catch (IllegalAccessException | InvocationTargetException e) {
throw new RuntimeException(e);
}
}
}
}

2
kernel-d-event/event-spring-boot-starter/README.md Normal file
View File

@ -0,0 +1,2 @@
# Spring Boot自动装配

29
kernel-d-event/event-spring-boot-starter/pom.xml Normal file
View File

@ -0,0 +1,29 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>cn.stylefeng.roses</groupId>
<artifactId>kernel-d-event</artifactId>
<version>8.0.0</version>
<relativePath>../pom.xml</relativePath>
</parent>
<artifactId>event-spring-boot-starter</artifactId>
<packaging>jar</packaging>
<dependencies>
<!--业务事件业务模块-->
<dependency>
<groupId>cn.stylefeng.roses</groupId>
<artifactId>event-sdk</artifactId>
<version>${roses.version}</version>
</dependency>
</dependencies>
</project>

38
kernel-d-event/event-spring-boot-starter/src/main/java/cn/stylefeng/roses/kernel/event/starter/EventAutoConfiguration.java Normal file
View File

@ -0,0 +1,38 @@
/*
* Copyright [2020-2030] [https://www.stylefeng.cn]
*
* 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.
*
* Guns采用APACHE LICENSE 2.0开源协议，您在使用过程中，需要注意以下几点：
*
* 1.请不要删除和修改根目录下的LICENSE文件。
* 2.请不要删除和修改Guns源码头部的版权声明。
* 3.请保留源码和相关描述文件的项目出处，作者声明等。
* 4.分发源码时候，请注明软件出处 https://gitee.com/stylefeng/guns
* 5.在修改包名，模块名称，项目代码等时，请注明软件出处 https://gitee.com/stylefeng/guns
* 6.若您的项目无法满足以上几点，可申请商业授权
*/
package cn.stylefeng.roses.kernel.event.starter;
import org.springframework.context.annotation.Configuration;
/**
* 业务事件自动装配
*
* @author fengshuonan
* @date 2023-07-14 15:05:54
*/
@Configuration
public class EventAutoConfiguration {
}

2
kernel-d-event/event-spring-boot-starter/src/main/resources/META-INF/spring.factories Normal file
View File

@ -0,0 +1,2 @@
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
cn.stylefeng.roses.kernel.event.starter.EventAutoConfiguration

35
kernel-d-event/pom.xml Normal file
View File

@ -0,0 +1,35 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>cn.stylefeng.roses</groupId>
<artifactId>roses-kernel</artifactId>
<version>8.0.0</version>
<relativePath>../pom.xml</relativePath>
</parent>
<artifactId>kernel-d-event</artifactId>
<packaging>pom</packaging>
<modules>
<module>event-api</module>
<module>event-sdk</module>
<module>event-spring-boot-starter</module>
</modules>
<dependencies>
<!-- 开发规则 -->
<dependency>
<groupId>cn.stylefeng.roses</groupId>
<artifactId>kernel-a-rule</artifactId>
<version>${roses.version}</version>
</dependency>
</dependencies>
</project>

3
pom.xml
View File

@ -40,6 +40,9 @@
<!--邮件发送模块-->
<module>kernel-d-email</module>
<!--业务事件模块-->
<module>kernel-d-event</module>
<!--文件操作模块-->
<module>kernel-d-file</module>