1、添加ModuleOperatorLog实体对象，并创建与之对应的logback的ModuleOperatorDbAppender扩展

2、添加Log相关枚举的Jpa convert，用于ModuleOperatorLog实体枚举类型属性 3、添加PlanLogger，统一记录排班计划的创建修改的日志（TODO：之后还要修改） 4、添加TimetableLogger，统一记录时刻表的创建，导入，修改的日志（TODO：之后还要修改） 5、修改logback.xml配置，配置append扩展日志（TODO：之后还要修改） 6、修改pom.xml配置，添加bsth-control_v2-plan_module-common依赖

1、添加ModuleOperatorLog实体对象，并创建与之对应的logback的ModuleOperatorDbAppender扩展
2、添加Log相关枚举的Jpa convert，用于ModuleOperatorLog实体枚举类型属性 3、添加PlanLogger，统一记录排班计划的创建修改的日志（TODO：之后还要修改） 4、添加TimetableLogger，统一记录时刻表的创建，导入，修改的日志（TODO：之后还要修改） 5、修改logback.xml配置，配置append扩展日志（TODO：之后还要修改） 6、修改pom.xml配置，添加bsth-control_v2-plan_module-common依赖
徐烜
1 parent 7dfd8bc8
Showing 9 changed files with 580 additions and 0 deletions
pom.xml
src/main/java/com/bsth/entity/schedule/log/ModuleOperatorLog.java
src/main/java/com/bsth/entity/schedule/log/convert/ModuleOperatorTypeConverter.java
src/main/java/com/bsth/entity/schedule/log/convert/ModuleTypeConverter.java
src/main/java/com/bsth/entity/schedule/log/convert/OperatorTypeConverter.java
src/main/java/com/bsth/service/schedule/log/ModuleOperatorDbAppender.java
src/main/java/com/bsth/service/schedule/log/PlanLogger.java
src/main/java/com/bsth/service/schedule/log/TimetableLogger.java
src/main/resources/logback.xml
@@ -295,6 +295,13 @@
 			<artifactId>jpinyin</artifactId>
 			<version>1.1.8</version>
 		</dependency>
+
+        <!-- plan common工程依赖 -->
+        <dependency>
+            <groupId>com.bsth.control_v2</groupId>
+            <artifactId>plan_module-common</artifactId>
+            <version>1.0-SNAPSHOT</version>
+        </dependency>
 	</dependencies>
  
 	<dependencyManagement>
+package com.bsth.entity.schedule.log;
+
+import com.bsth.control_v2.plan_module.common.enums.log.ModuleOperatorType;
+import com.bsth.control_v2.plan_module.common.enums.log.ModuleType;
+import com.bsth.control_v2.plan_module.common.enums.log.OperatorType;
+import com.bsth.entity.schedule.log.convert.ModuleOperatorTypeConverter;
+import com.bsth.entity.schedule.log.convert.ModuleTypeConverter;
+import com.bsth.entity.schedule.log.convert.OperatorTypeConverter;
+
+import javax.persistence.*;
+import java.io.Serializable;
+import java.util.Date;
+
+/**
+ * 模块业务操作日志。
+ */
+@Entity
+@Table(name = "bsth_c_s_op_log")
+public class ModuleOperatorLog implements Serializable {
+
+    /** 主键Id */
+    @Id
+    @GeneratedValue
+    private Long id;
+
+    /** 日志插入时间 */
+    @Column(nullable = false)
+    private Long timestmp;
+
+    /** 模块类型 */
+    @Column(nullable = false)
+    @Convert(converter = ModuleTypeConverter.class)
+    private ModuleType moduleType;
+
+    @Column(nullable = false)
+    @Convert(converter = OperatorTypeConverter.class)
+    private OperatorType operatorType;
+
+    /** 模块操作类型 */
+    @Column(nullable = false)
+    @Convert(converter = ModuleOperatorTypeConverter.class)
+    private ModuleOperatorType moduleOperatorType;
+
+    /** 日志描述 */
+    @Column(nullable = false)
+    private String message;
+
+    /** 日志级别 */
+    @Column(nullable = false)
+    private String levelName;
+    /** 模块业务操作开始时间 */
+    @Column(nullable = false)
+    private Date opStartTime;
+    /** 模块业务操作结束时间 */
+    @Column(nullable = false)
+    private Date opEndTime;
+    /** 模块业务操作人姓名 */
+    @Column(nullable = false)
+    private String opUserName;
+    /** 模块业务操作人工号 */
+    @Column(nullable = false)
+    private String opUserCode;
+    /** 关联的实体class名 */
+    @Column(nullable = false)
+    private String opEntityClass;
+    /** 操作前的实体json */
+    @Column(nullable = false)
+    private String opBeforeJson;
+    /** 操作后的实体json */
+    @Column(nullable = false)
+    private String opAfterJson;
+
+    /** 备用-可选参数1 */
+    private String optArg1;
+    /** 备用-可选参数2 */
+    private String optArg2;
+    /** 备用-可选参数3 */
+    private String optArg3;
+
+    public Long getId() {
+        return id;
+    }
+
+    public void setId(Long id) {
+        this.id = id;
+    }
+
+    public Long getTimestmp() {
+        return timestmp;
+    }
+
+    public void setTimestmp(Long timestmp) {
+        this.timestmp = timestmp;
+    }
+
+    public ModuleType getModuleType() {
+        return moduleType;
+    }
+
+    public void setModuleType(ModuleType moduleType) {
+        this.moduleType = moduleType;
+    }
+
+    public OperatorType getOperatorType() {
+        return operatorType;
+    }
+
+    public void setOperatorType(OperatorType operatorType) {
+        this.operatorType = operatorType;
+    }
+
+    public ModuleOperatorType getModuleOperatorType() {
+        return moduleOperatorType;
+    }
+
+    public void setModuleOperatorType(ModuleOperatorType moduleOperatorType) {
+        this.moduleOperatorType = moduleOperatorType;
+    }
+
+    public String getMessage() {
+        return message;
+    }
+
+    public void setMessage(String message) {
+        this.message = message;
+    }
+
+    public String getLevelName() {
+        return levelName;
+    }
+
+    public void setLevelName(String levelName) {
+        this.levelName = levelName;
+    }
+
+    public Date getOpStartTime() {
+        return opStartTime;
+    }
+
+    public void setOpStartTime(Date opStartTime) {
+        this.opStartTime = opStartTime;
+    }
+
+    public Date getOpEndTime() {
+        return opEndTime;
+    }
+
+    public void setOpEndTime(Date opEndTime) {
+        this.opEndTime = opEndTime;
+    }
+
+    public String getOpUserName() {
+        return opUserName;
+    }
+
+    public void setOpUserName(String opUserName) {
+        this.opUserName = opUserName;
+    }
+
+    public String getOpUserCode() {
+        return opUserCode;
+    }
+
+    public void setOpUserCode(String opUserCode) {
+        this.opUserCode = opUserCode;
+    }
+
+    public String getOpEntityClass() {
+        return opEntityClass;
+    }
+
+    public void setOpEntityClass(String opEntityClass) {
+        this.opEntityClass = opEntityClass;
+    }
+
+    public String getOpBeforeJson() {
+        return opBeforeJson;
+    }
+
+    public void setOpBeforeJson(String opBeforeJson) {
+        this.opBeforeJson = opBeforeJson;
+    }
+
+    public String getOpAfterJson() {
+        return opAfterJson;
+    }
+
+    public void setOpAfterJson(String opAfterJson) {
+        this.opAfterJson = opAfterJson;
+    }
+
+    public String getOptArg1() {
+        return optArg1;
+    }
+
+    public void setOptArg1(String optArg1) {
+        this.optArg1 = optArg1;
+    }
+
+    public String getOptArg2() {
+        return optArg2;
+    }
+
+    public void setOptArg2(String optArg2) {
+        this.optArg2 = optArg2;
+    }
+
+    public String getOptArg3() {
+        return optArg3;
+    }
+
+    public void setOptArg3(String optArg3) {
+        this.optArg3 = optArg3;
+    }
+}
+package com.bsth.entity.schedule.log.convert;
+
+import com.bsth.control_v2.plan_module.common.enums.log.ModuleOperatorType;
+
+import javax.persistence.AttributeConverter;
+import javax.persistence.Convert;
+
+@Convert
+public class ModuleOperatorTypeConverter implements AttributeConverter<ModuleOperatorType, String> {
+    @Override
+    public String convertToDatabaseColumn(ModuleOperatorType attribute) {
+        return attribute.getDicDesc();
+    }
+
+    @Override
+    public ModuleOperatorType convertToEntityAttribute(String dbData) {
+        return ModuleOperatorType.fromDicDesc(dbData);
+    }
+}
+package com.bsth.entity.schedule.log.convert;
+
+import com.bsth.control_v2.plan_module.common.enums.log.ModuleType;
+
+import javax.persistence.AttributeConverter;
+import javax.persistence.Convert;
+
+@Convert
+public class ModuleTypeConverter implements AttributeConverter<ModuleType, String> {
+    @Override
+    public String convertToDatabaseColumn(ModuleType attribute) {
+        return attribute.getDicDesc();
+    }
+
+    @Override
+    public ModuleType convertToEntityAttribute(String dbData) {
+        return ModuleType.fromDicDesc(dbData);
+    }
+}
+package com.bsth.entity.schedule.log.convert;
+
+import com.bsth.control_v2.plan_module.common.enums.log.OperatorType;
+
+import javax.persistence.AttributeConverter;
+import javax.persistence.Convert;
+
+@Convert
+public class OperatorTypeConverter implements AttributeConverter<OperatorType, String> {
+    @Override
+    public String convertToDatabaseColumn(OperatorType attribute) {
+        return attribute.getDicDesc();
+    }
+
+    @Override
+    public OperatorType convertToEntityAttribute(String dbData) {
+        return OperatorType.fromDicDesc(dbData);
+    }
+}
+package com.bsth.service.schedule.log;
+
+import ch.qos.logback.classic.spi.ILoggingEvent;
+import ch.qos.logback.core.db.DBAppenderBase;
+import ch.qos.logback.core.db.DBHelper;
+import com.bsth.control_v2.plan_module.common.exception.PlanModuleException;
+import com.bsth.entity.schedule.log.ModuleOperatorLog;
+
+import java.lang.reflect.Method;
+import java.sql.Connection;
+import java.sql.Date;
+import java.sql.PreparedStatement;
+
+/**
+ * 自定义模块业务操作日志logback自定义appender。
+ */
+public class ModuleOperatorDbAppender extends DBAppenderBase<ILoggingEvent> {
+    /** JDBC3.0中的绑定表自增的主键值，获取result需要此方法 */
+    protected static final Method GET_GENERATED_KEYS_METHOD;
+    /** 插入日志sql */
+    protected static final String INSERT_SQL;
+
+    @Override
+    public void start() {
+        super.start();
+    }
+
+    @Override
+    protected Method getGeneratedKeysMethod() {
+        return GET_GENERATED_KEYS_METHOD;
+    }
+
+    @Override
+    protected String getInsertSQL() {
+        return INSERT_SQL;
+    }
+
+    @Override
+    protected void subAppend(ILoggingEvent iLoggingEvent, Connection connection, PreparedStatement insertStatement) throws Throwable {
+        // 参数判定，第一个参数必须是ModuleOperatorLog，后续的参数最多取3个
+        if (iLoggingEvent.getArgumentArray().length == 0) {
+            throw new PlanModuleException(iLoggingEvent.getLoggerName() + "日志参数必须大于1");
+        } else {
+            Object arg1 = iLoggingEvent.getArgumentArray()[0];
+            if (!(arg1 instanceof ModuleOperatorLog)) {
+                throw new PlanModuleException(iLoggingEvent.getLoggerName() + "日志第一个参数必须是ModuleOperatorLog类型");
+            } else {
+                ModuleOperatorLog arg1_log = (ModuleOperatorLog) arg1;
+                // insertStatement设定ModuleOperatorLog关联数据
+                insertStatement.setLong(1, iLoggingEvent.getTimeStamp());
+                insertStatement.setString(2, arg1_log.getModuleType().getDicDesc());
+                insertStatement.setString(3, arg1_log.getOperatorType().getDicDesc());
+                insertStatement.setString(4, arg1_log.getModuleOperatorType().getDicDesc());
+                insertStatement.setString(5, arg1_log.getMessage());
+                insertStatement.setString(6, iLoggingEvent.getLevel().levelStr);
+                insertStatement.setDate(7, new Date(arg1_log.getOpStartTime().getTime()));
+                insertStatement.setDate(8, new Date(arg1_log.getOpEndTime().getTime()));
+                insertStatement.setString(9, arg1_log.getOpUserName());
+                insertStatement.setString(10, arg1_log.getOpUserCode());
+                insertStatement.setString(11, arg1_log.getOpEntityClass());
+                insertStatement.setString(12, arg1_log.getOpBeforeJson());
+                insertStatement.setString(13, arg1_log.getOpAfterJson());
+                insertStatement.setString(14, "");
+                insertStatement.setString(15, "");
+                insertStatement.setString(16, "");
+
+                for (int i = 1; i < iLoggingEvent.getArgumentArray().length; i++) {
+                    if (i == 1) {
+                        insertStatement.setString(14, iLoggingEvent.getArgumentArray()[i].toString());
+                    } else if (i == 2) {
+                        insertStatement.setString(15, iLoggingEvent.getArgumentArray()[i].toString());
+                    } else if (i == 3) {
+                        insertStatement.setString(16, iLoggingEvent.getArgumentArray()[i].toString());
+                    } else {
+                        break;
+                    }
+                }
+
+                int updateCount = insertStatement.executeUpdate();
+                if (updateCount != 1) {
+                    addWarn("Failed to insert loggingEvent");
+                }
+            }
+        }
+
+    }
+
+    @Override
+    protected void secondarySubAppend(ILoggingEvent iLoggingEvent, Connection connection, long l) throws Throwable {
+        // TODO：
+    }
+
+    @Override
+    public void append(ILoggingEvent eventObject) {
+        Connection connection = null;
+        PreparedStatement insertStatement = null;
+        try {
+            connection = this.connectionSource.getConnection();
+            connection.setAutoCommit(false);
+            insertStatement = connection.prepareStatement(INSERT_SQL);
+            synchronized (this) {
+                subAppend(eventObject, connection, insertStatement);
+            }
+            // TODO：可能以后需要secondarySubAppend
+
+            connection.commit();
+        } catch (Throwable exp) {
+            exp.printStackTrace();
+            this.addError("problem appending event", exp);
+        } finally {
+            DBHelper.closeStatement(insertStatement);
+            DBHelper.closeConnection(connection);
+        }
+    }
+
+    static {
+        StringBuilder sql = new StringBuilder();
+        sql.append("insert into bsth_c_s_op_log (");
+        sql.append("timestmp, ");
+        sql.append("module_type, ");
+        sql.append("operator_type, ");
+        sql.append("module_operator_type, ");
+        sql.append("message, ");
+        sql.append("level_name, ");
+        sql.append("op_start_time, ");
+        sql.append("op_end_time, ");
+        sql.append("op_user_name, ");
+        sql.append("op_user_code, ");
+        sql.append("op_entity_class, ");
+        sql.append("op_before_json, ");
+        sql.append("op_after_json, ");
+        sql.append("opt_arg1, ");
+        sql.append("opt_arg2, ");
+        sql.append("opt_arg3) ");
+        sql.append(" values (?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?)");
+        INSERT_SQL = sql.toString();
+
+        Method getGeneratedKeysMethod;
+        try {
+            getGeneratedKeysMethod = PreparedStatement.class.getMethod("getGeneratedKeys", (Class[])null);
+        } catch (Exception exp) {
+            getGeneratedKeysMethod = null;
+        }
+
+        GET_GENERATED_KEYS_METHOD = getGeneratedKeysMethod;
+    }
+}
+package com.bsth.service.schedule.log;
+
+import com.bsth.control_v2.plan_module.common.dto.schedule.PlanInfoDto;
+import com.bsth.control_v2.plan_module.common.enums.log.ModuleOperatorType;
+import com.bsth.control_v2.plan_module.common.enums.log.ModuleType;
+import com.bsth.control_v2.plan_module.common.enums.log.OperatorType;
+import com.bsth.entity.schedule.SchedulePlan;
+import com.bsth.entity.schedule.log.ModuleOperatorLog;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.stereotype.Service;
+
+import java.util.Date;
+
+/**
+ * 排班计划日志。
+ */
+@Service
+public class PlanLogger {
+    /** 日志记录器 */
+    private static final Logger LOGGER = LoggerFactory.getLogger(PlanLogger.class);
+
+    /**
+     * 生成排班计划日志。
+     * @param startTime 操作开始时间
+     * @param endTime 操作结束时间
+     */
+    public void createLog(Date startTime, Date endTime) {
+        ModuleOperatorLog moduleOperatorLog = new ModuleOperatorLog();
+        moduleOperatorLog.setMessage("排班生成！");
+        moduleOperatorLog.setModuleType(ModuleType.SCHEDULE);
+        moduleOperatorLog.setOperatorType(OperatorType.NEW);
+        moduleOperatorLog.setModuleOperatorType(ModuleOperatorType.SCHEDULE_NEW);
+        moduleOperatorLog.setOpStartTime(startTime);
+        moduleOperatorLog.setOpEndTime(endTime);
+        moduleOperatorLog.setOpUserName("root");
+        moduleOperatorLog.setOpUserCode("root");
+        moduleOperatorLog.setOpEntityClass(SchedulePlan.class.getName());
+        moduleOperatorLog.setOpBeforeJson("{}");
+        moduleOperatorLog.setOpAfterJson("{}");
+
+        // 如果需要opArg1,opArg2,opArg3，从第2个参数加起，如：LOGGER.info("", {moduleOperatorLog}, {opArg1}, {opArg2})
+        LOGGER.info("排班计划生成日志：{}", moduleOperatorLog);
+    }
+
+    /**
+     * 修改排班计划明细日志。
+     * @param startTime 操作开始时间
+     * @param beforeData 修改前数据
+     * @param endTime 操作结束时间
+     * @param afterData 修改后数据
+     */
+    public void modifyInfoLog(Date startTime, PlanInfoDto beforeData, Date endTime, PlanInfoDto afterData) {
+        // TODO：
+    }
+}
+package com.bsth.service.schedule.log;
+
+import com.bsth.control_v2.plan_module.common.dto.schedule.timetable.TTInfoDetailDto;
+import com.bsth.control_v2.plan_module.common.dto.schedule.timetable.TTInfoDto;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.stereotype.Service;
+
+import java.util.Date;
+
+/**
+ * 时刻表日志。
+ */
+@Service
+public class TimetableLogger {
+    /** 日志记录器 */
+    private static final Logger LOGGER = LoggerFactory.getLogger(TimetableLogger.class);
+
+    /**
+     * 生成时刻表模版日志。
+     * @param startTime 操作开始时间
+     * @param endTime 操作结束时间
+     */
+    public void createTTLog(Date startTime, Date endTime) {
+        // TODO：
+    }
+
+    /**
+     * 修改时刻表模版日志。
+     * @param startTime 操作开始时间
+     * @param beforeData 修改前数据
+     * @param endTime 操作结束时间
+     * @param afterData 修改后数据
+     */
+    public void modifyTTLog(Date startTime, TTInfoDto beforeData, Date endTime, TTInfoDto afterData) {
+        // TODO：
+    }
+
+    /**
+     * 导入时刻表明细日志。
+     * @param startTime 操作开始时间
+     * @param endTime 操作结束时间
+     */
+    public void importTTDLog(Date startTime, Date endTime) {
+        // TODO：导入前备份一次，导入后备份一次，备份前后的id放入before和after中
+    }
+
+    /**
+     * 修改时刻表明细日志。
+     * @param startTime 操作开始时间
+     * @param beforeData 修改前数据
+     * @param endTime 操作结束时间
+     * @param afterData 修改后数据
+     */
+    public void modifyTTDLog(Date startTime, TTInfoDetailDto beforeData, Date endTime, TTInfoDetailDto afterData) {
+        // TODO：
+    }
+}
@@ -160,6 +160,46 @@
 	</logger>
  
  
+    <!-- 时刻表，排班计划业务修改日志 -->
+    <!--<springProfile name="dev">-->
+        <appender name="MYDB" class="com.bsth.service.schedule.log.ModuleOperatorDbAppender">
+            <connectionSource class="ch.qos.logback.core.db.DataSourceConnectionSource">
+                <dataSource class="org.apache.commons.dbcp.BasicDataSource">
+                    <driverClassName>com.mysql.jdbc.Driver</driverClassName>
+                    <url>
+                        <![CDATA[
+                            jdbc:mysql://127.0.0.1/test_control?useUnicode=true&characterEncoding=utf-8&useSSL=false
+                        ]]>
+                    </url>
+                    <username>root</username>
+                    <password></password>
+                    <testOnBorrow>true</testOnBorrow>
+                    <validationQuery>
+                        <![CDATA[
+                            SELECT 1
+                        ]]>
+                    </validationQuery>
+                </dataSource>
+            </connectionSource>
+        </appender>
+    <!--</springProfile>-->
+
+    <appender name="ASYNC_MYDB" class="ch.qos.logback.classic.AsyncAppender">
+        <!-- 不丢失日志.默认的,如果队列的80%已满,则会丢弃TRACT、DEBUG、INFO级别的日志 -->
+        <discardingThreshold >0</discardingThreshold>
+        <!-- 更改默认的队列的深度,该值会影响性能.默认值为256 -->
+        <queueSize>512</queueSize>
+        <!-- 添加附加的appender,最多只能添加一个 -->
+        <appender-ref ref ="MYDB"/>
+    </appender>
+
+    <logger name="com.bsth.service.schedule.log.PlanLogger"
+            level="INFO" additivity="false">
+        <appender-ref ref="ASYNC_MYDB" />
+    </logger>
+
+    <!-- TODO -->
+
 	<!-- gps -->
 	<appender name="GPS_COUNT"
 			  class="ch.qos.logback.core.rolling.RollingFileAppender">