开发过程中规范说明与记录

系统管理员 2023-08-17 17:28 178阅读 0赞

##### 开发过程中需要的文件 #####

1.  .gitignore  
    准备一份标准的.gitignore文件。
2.  README.md  
    使用markdown的语法，写一些项目背景和核心流程逻辑。
3.  init.sql  
    随着项目变更，准备一份标准的初始化sql脚本。
4.  application.yaml  
    application-dev.yaml  
    application-prod.yaml  
    application-test.yaml  
    为项目准备多份配置文件信息。方便切换。

--------------------

##### 开发过程需要的git分支 #####

1.  origin/master
2.  origin/dev
3.  origin/test
4.  origin/prod
5.  origin/feature-user

--------------------

##### 测试过程中需要的shell文件 #####

1.  start.sh

#!/usr/bin/env bash
    	CURRENT=$(cd $(dirname $0);pwd)
    nohup java -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=8000 -jar $CURRENT/target/**xx**-*.jar >>log.out  2>&1 &

说明：  
CURRENT是得到当前shell脚本的路径。然后采用nohup的方式启动jar包，agentlib是启动的一些参数设置，在idea编辑器中也可以进行设置。一般如果有target的话，就是环境上有maven，打包后的jar在target目录下。其中>>表示以追加的方式把打印信息写到log.out文件中，2是文件描述符的一个类别是错误的信息，  
2>$1

表示把错误的信息重新使用管道的方式写到标准输出中，也就是标准的信息和错误的信息都写到log.out文件中，最后一个$表示，以后后台进程的方式启动jar。其中xx代表项目名称或者jar包名称。

1.  stop.sh

#!/usr/bin/env bash
    
    CURRENT=$(cd $(dirname $0);pwd)
    
    pkill -f $CURRENT/target/xx-*.jar
    
    try=3
    while [ $try -ge 0 ];do
        let try=$try-1
        pid=$(pgrep -f $CURRENT/target/xx-*.jar)
        if [ "$pid" = "" ];then
          break
        else
          echo "Waiting process[$pid] to exit gracefully..."
          sleep 1
        fi
    done
    
    if [ "$pid" != "" ];then
       echo "Kill $pid brutally"
        kill -9 $pid
    fi

说明：CURRENT获取到stop脚本的路径，pkill -f 强制把此jar项目的所有进程全部kill掉。如果没有被kill调用，再次循环3次去kill掉进程。如果try大于0的话，就执行后续逻辑，其中let表示后面跟上算术运行表达式。pgrep表示获取进程相关信息，这里获取pid。如果没有获取到，就停止当前循环，进入下次循环。如果有进程相关信息，则野蛮地kill。

1.  projectName.sh

#!/bin/bash
    branch=dev #想要拉取的分支名称
    CURRENT=$(cd $(dirname $0);pwd) # 获取当前目录
    git_dir=$CURRENT
    backups_home=$CURRENT/backups # 定义一个备份目录
    backups_path=$backups_home/`date +%Y-%m-%d`/  # 当天执行后得到一个当天的日期
    echo "拉取git仓库源码start"
    cd $git_dir
    now=`date '+%Y-%m-%d %H:%M:%S'`
    git checkout $branch
    check_new=`git pull`
    if [[ $check_new =~ "Already" ]] # 判断是否有新的版本
    then
      minute=`date '+%M'`
      if [ $minute -lt 10 ]
      then
        echo "拉取git仓库源码end"
        echo "$now 没有可更新的版本"
      fi
        echo "拉取git仓库源码end"
    else
      echo "拉取git仓库源码end"
      mkdir -p $backups_path
      echo "备份start,备份路径:"$backups_path
      cp $git_dir/target/exchange*.jar $backups_path
      echo "备份end"
    
      cd $git_dir
      echo "mvn编译打包start"
      mvn clean install -Ptest -Dmaven.test.skip=true
      echo "mvn编译打包end"
       echo "关闭服务器"
      bash $git_dir/stop.sh
      sleep 5
      echo "正在启动,当前分支:" $branch"……"
      bash $git_dir/start.sh
      echo "启动命令执行完毕"
     fi

说明：注意开发环境，如果开发在windowns上话，mvn package的时候需要如下插件。

<plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                    <compilerArguments>
                        <verbose/>
                        <bootclasspath>${java.home}\lib\rt.jar;${java.home}\lib\jce.jar</bootclasspath>
                    </compilerArguments>
              </configuration>
    </plugin>

linux环境的需要，

<plugin>
           <groupId>org.apache.maven.plugins</groupId>
           <artifactId>maven-compiler-plugin</artifactId>
              <configuration>
                 <source>1.8</source>
                  <target>1.8</target>
                   <compilerArguments>
                   		<verbose/>
                    	<bootclasspath>${java.home}/lib/rt.jar:${java.home}/lib/jce.jar</bootclasspath>
                   </compilerArguments>
                </configuration>
      </plugin>

--------------------

##### 运维需要的文件 #####

1.  start.sh

#!/usr/bin/env bash
    CURRENT=$(cd $(dirname $0);pwd)
    nohup java $JAVA_OPTS -Xms512m -Xmx512m -Dserver.port=8000 -Dlogs.dir=$2 -jar $CURRENT/xx-*.jar >>$CURRENT/log.out  2>$1 &

1.  stop.sh

说明：生成环境直接把jar上传到服务器上，先执行stop.sh，然后执行start.sh即可。

#### 小结 ####

1.  一个项目需要最基本的文件，application.yaml系列。README.md,init.sql,.gitigniore文件。
2.  开发过程中，标准git分支。master,dev,test,prod以及组内成员功能分支比如feature-user等。
3.  测试环境中的脚本准备和说明。（需要git和maven环境）
4.  生成环境中的脚本准备和使用。
5.  这些实践来自公司同事探索和努力。整理一下，把实践过程分享出来。能够为软件行业添一砖一瓦。