BM系列之 产品开发经验

这个系列的文章将主要介绍BM这个产品，这个产品从16年5月份开始酝酿，8月份正式开始开发，到12月底正式发布，中间历经4个月；开发人员一共6人。

下面将从产品开发的各个方面来一一介绍，包括架构，持续集成，排错，版本管理。

一 架构。

好的架构就像是地基。

二 持续集成

持续集成就是监工，在建造过程中持续跟踪检查，保证大厦没有偏离方向。

我们使用的是jenkins+SonarQube，具体使用就不讲了，说说jenkins在我们工作流中的位置。

所有的打包操作都交给jenkins来做，估计大家也应该经历过其他形式的打包，比如用eclipse导出jar包，用maven打包等。jenkins的好处就是标准化，统一；要是本地打包，受到的干扰可就大了，自己临时注掉了某行代码测试，结果打包时没发现，后续的事情自己想象吧，可能一干都天明了。

我们还设定每天凌晨2点打一个包，然后自动部署到测试环境，这样保证我们提交的代码都是没有问题的，还能通过sonar检查代码质量帮助大家修改。

三 排错

当服务器工程师说他也不知道发生怎么回事的时候，整个世界都崩塌了。

产品出现错误可谓很正常，不出错才不正常，出现错如何排查呢。开发环境直接debug，断点是最简单的方式了；本地环境直接远程调试。那要是生产环境呢，比如银行的封闭内网。这个时候，工程师的经验就体现出来了，一个有经验的工程师这时会直接去查看运行log，定位问题的原因；而一个没经验的程序员只能说，我这没问题啊，囧。

所以，log在排错的过程中至关重要，用log排错的效率也要比debug高很多。那怎么来定义log呢，常用的有log4j，logback等。常规的是用来关闭打开debug log，当然更合理的是将不同级别的日志输出到不同的文件，并定义不同的规则，如日志大小，保留时间。

我们的日志规则，error，audit，info log 不分大小，永久保留；
all log保留两天，最多1G；debug log限定500m，保留两天；
具体日志定义

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="5 seconds">
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <!-- encoders are assigned the type
             ch.qos.logback.classic.encoder.PatternLayoutEncoder by default -->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>DEBUG</level>
        </filter>
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>
    <appender  name="ALL_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <File>../../logs/agent-all.log</File>
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>DEBUG</level>
        </filter>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>../../logs/agent-all-%d{yyyyMMdd}.log.%i
            </fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
            </timeBasedFileNamingAndTriggeringPolicy>
            <maxHistory>2</maxHistory>
            <maxFileSize>100MB</maxFileSize>
            <totalSizeCap>1GB</totalSizeCap>
        </rollingPolicy>
        <layout class="ch.qos.logback.classic.PatternLayout">
            <Pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} -%msg%n
            </Pattern>
        </layout>
    </appender>
    <!--日常日志-->
    <appender  name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <File>../../logs/agent-info.log</File>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>INFO</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>../../logs/agent-info-%d{yyyyMMdd}.log.%i
            </fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <layout class="ch.qos.logback.classic.PatternLayout">
            <Pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} -%msg%n
            </Pattern>
        </layout>
    </appender>
    <!--日常日志-->
    <appender  name="DEBUG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <File>../../logs/agent-debug.log</File>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>DEBUG</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>../../logs/agent-debug-%d{yyyyMMdd}.log.%i
            </fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
            </timeBasedFileNamingAndTriggeringPolicy>
            <maxHistory>2</maxHistory>
            <maxFileSize>100MB</maxFileSize>
            <totalSizeCap>100MB</totalSizeCap>
        </rollingPolicy>
        <layout class="ch.qos.logback.classic.PatternLayout">
            <Pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} -%msg%n
            </Pattern>
        </layout>
    </appender>
    <!--审计日志-->
	<appender  name="AUDIT_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <File>../../logs/agent-audit.log</File>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>../../logs/agent-audit-%d{yyyyMMdd}.log.%i
            </fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <layout class="ch.qos.logback.classic.PatternLayout">
            <Pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} -%msg%n
            </Pattern>
        </layout>
    </appender>

    <!--错误日志-->
    <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERROR</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <File>../../logs/agent-error.log</File>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>../../logs/agent-error-%d{yyyyMMdd}.log.%i
            </fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <layout class="ch.qos.logback.classic.PatternLayout">
            <Pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} -%msg%n

            </Pattern>
        </layout>
    </appender>
    <logger name="com.bonc.manager.web.modules.audit.aspect.AuditLogAop"  level="debug" additivity="true" >
    	<appender-ref ref="AUDIT_FILE"/>
    </logger>
    <logger name="com.bonc"  level="DEBUG" additivity="true" >
        <!--<appender-ref ref="DEBUG_FILE"/>-->
        <!--<appender-ref ref="STDOUT"/>-->
    </logger>
    <root level="INFO">
        <appender-ref ref="ALL_FILE" />
        <appender-ref ref="DEBUG_FILE" />
        <appender-ref ref="INFO_FILE" />
        <appender-ref ref="ERROR_FILE" />
    </root>
    
</configuration>

四 版本管理

版本管理不只是备份代码那么简单。

版本管理不只是备份代码那么简单，它解决的是协同开发的问题，曾经某一刹那对于分支开发模式很是惊叹，但被随后的合并黑洞搞得乌七八糟后，痛定思动，回归单一主干方式。
所谓单一主干，就是只有一个主干，所有的开发都在主干上进行。这可以让冲突尽早暴露，尽早解决，而不是等到最后。俗话说，如果要失败，就尽快。
当然除了单一主干外，还要配合功能锁的设置，才能保证在存在未完成功能的情况下进行版本发布。

五 代码review

三人行，必有我师。