项目维护小记-初入坑
入坑背景
最近接手维护一个商城&交易后台系统,主要应用的技术框架、工具如下:
- SpringMVC
- MyBatis
- JSP
- dubbo
项目由于经过多次转手,期间使用的工具、开发人员(多为在校学生)技术水准比较不统一,代码可维护性很低。 项目虽然可以踉踉跄跄跑起来,但存在较大的隐患,部署难度也比较大。于是对项目结构优化改造、bug修改成了最近的主要工作。
今后的几篇随笔,将会对项目维护过程中遇的问题及填坑方式,按照开发流程层次(框架搭建、业务代码实现、打包部署)做下记录。这些问题可能是初学web开发的同学经常遇到的。
基本项目结构改造
原本项目有多个模块组成,分别为独立的工程,要命的是工程之间还存在依赖。如果在公司内网中配置有中央maven仓库,这样做是没有问题的,快照版本的依赖可以随时升级,目前不具备这样的条件,为了简化开发,只能强行把分离的项目合并为子模块。
合并后根目录下 pom.xml 模块定义如下:
<modules>
<!--service接口、model、util定义,被其他模块依赖-->
<module>electron-interface</module>
<!--基于dubbo提供rpc调用接口,需单独运行-->
<module>back-service</module>
<!--商城web项目-->
<module>mall</module>
<!--交易web项目-->
<module>business</module>
</modules>
模块名称中中线原来都是下划线,会出现jar包文件找不到的问题,替换掉下划线后问题消失, 反正从来没有在项目名称中使用过下划线,懒得去验证是不是下划线问题
maven插件配置
项目比较简单,不需要各种奇奇怪怪而又用不到的插件, 只需要一个maven编译插件即可,注意,如果本机安装多个java版本,尤其是当前项目还需要降低java版本时(1.8降低到1.7),一定要注意配置好java版本号。
<properties>
<java-version>1.7</java-version>
</properties>
......省略其他配置
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.6.1</version>
<configuration>
<source>1.7</source>
<target>1.7</target>
<encoding>UTF-8</encoding>
</configuration>
</plugin>
</plugins>
</build>
对于web项目,如果在eclipse下开发,可以直接使用其界面工具导出war包。命令行的话需要配置war插件:
<build>
<finalName>mall</finalName>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-war-plugin</artifactId>
<version>2.3</version>
<configuration>
<failOnMissingWebXml>false</failOnMissingWebXml>
</configuration>
</plugin>
</plugins>
</build>
打包命令如下:
mvn package war:war
其中有一个back-service项目要以jar文件形式运行,需要配置maven-shade-plugin
插件,该插件会在maven package
时将所有依赖jar包及资源文件打包成一个文件,配置如下:
<build>
<finalName>back-service</finalName>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-shade-plugin</artifactId>
<version>3.0.0</version>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>shade</goal>
</goals>
<configuration>
<transformers>
<transformer
implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
<mainClass>com.anxin.Bootstrap</mainClass>
</transformer>
<transformer
implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
<resource>META-INF/spring.handlers</resource>
</transformer>
<transformer
implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
<resource>META-INF/spring.schemas</resource>
</transformer>
</transformers>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
这里不推荐使用其他方式打jar包,网上一定可以搜到诸如
maven-assembly-plugin
、maven-jar-plugin
等插件,一般来说它们打出的jar包是没有问题的,但是如果项目是基于spring的话就会有问题,主要它们是不能很好的处理spring.schemas
和spring. handlers
文件,处理不了,spring运行就会报错,具体原因可以查一下spring对xml文件schema的处理方式,这个会另起一篇随笔进行说明。
另外,在项目的 WEB-INF/lib下中存一些jar包,这些jar包不受maven控制,开发期间严重依赖IDE去引用,在package时很难加入到最终的jar包里,这里的策略是将这些jar包安装到本地仓库,然后就可以在pom.xml里安装常规方法加入依赖就可以了。
以下示例安装alipay的某个sdk:
command:
mvn install:install-file -Dfile=./lib/alipay-sdk-java-0.0.1.jar -DgroupId=com.alipay.api -DartifactId=alipay-sdk-java -Dversion=0.0.1 -Dpackaging=jar
pom.xml:
<dependency>
<groupId>com.alipay.api</groupId>
<artifactId>alipay-sdk-java</artifactId>
<version>0.0.1</version>
<!--本地依赖配置-->
<!--<systemPath>${project.basedir}/lib/alipay-sdk-java-0.0.1.jar</systemPath>-->
<!--<scope>system</scope>-->
</dependency>
总结
本文介绍了项目改造初期比较重要的maven配置项目。也同样适用于一般的maven模块化web项目开发。
下一篇会记录一些代码开发方面的问题,包括异常处理、分页查询、日志记录、以及jsp的一些“奇淫巧技”等基础而又常见的问题。