spring+maven不同環境讀取配置詳解

轉載：https://blog.csdn.net/xiao__miao/article/details/78460725

首先這個我看了網上很多資料，但我發現，由於自己一些技術的不熟悉，對於他人的文章有些誤解，導致我打包部署失敗。

話不多說，現在我們開始一步步工程

第一步，專案讀取不通環境的配置檔案

1. <?xml version="1.0" encoding="UTF-8"?>

2. <beans xmlns="http://www.springframework.org/schema/beans"

3. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

4. xmlns:context="http://www.springframework.org/schema/context"

5. xmlns:util="http://www.springframework.org/schema/util"

6. xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd

7. http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd

8. http://www.springframework.org/schema/util http://www.springframework.org/schema/util/spring-util.xsd">

9. <!-- 測試環境配置檔案 -->

10. <beans profile="local">

11. <context:property-placeholder location="classpath:local/config.properties" />

12. </beans>

13.  

14. <!-- 生產環境配置檔案 -->

15. <beans profile="product">

16. <context:property-placeholder location="classpath:product/config.properties" />

17. </beans>

18.  
19.  
20.  

21. </beans>

這是我定義的一個讀配置檔案的xml——applicationContext-profile.xml

這是由web.xml裡面配置，來區分去讀哪個配置檔案

1. <!-- 配置spring的預設profile

2. 可選值：product(生產環境) local(本地環境) -->

3. <context-param>

4. <param-name>spring.profiles.active</param-name>

5. <param-value>product</param-value>

6. </context-param>

7.  

8. <!-- spring hibernate -->

9. <context-param>

10. <param-name>contextConfigLocation</param-name>

11. <param-value>

12. classpath:public/spring/applicationContext-profile.xml

13. classpath:public/spring/spring-hibernate.xml

14. </param-value>

15. </context-param>

web.xml的一部分，根據配置去讀product還是local，這裡根據配置欄位能看到對於的配置檔案，這對應關係應該是能看懂的！

到這裡，你應該能根據自己的配置檔案去執行程式

第二步，根據pom檔案打包

1. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

2. xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

3. <parent>

4. <artifactId>officialProject</artifactId>

5. <groupId>com.wm</groupId>

6. <version>1.0-SNAPSHOT</version>

7. </parent>

8. <modelVersion>4.0.0</modelVersion>

9.  

10. <artifactId>offical-web</artifactId>

11. <packaging>war</packaging>

12.  

13. <name>offical-web</name>

14. <url>http://maven.apache.org</url>

15.  

16. <properties>

17. <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

18. <shiro-version>1.3.2</shiro-version>

19. </properties>

20.  

21. <dependencies>

22. <dependency>

23. <groupId>junit</groupId>

24. <artifactId>junit</artifactId>

25. <version>4.11</version>

26. <scope>test</scope>

27. </dependency>

28. <dependency>

29. <groupId>org.springframework</groupId>

30. <artifactId>spring-webmvc</artifactId>

31. <version>${spring.version}</version>

32. </dependency>

33. <dependency>

34. <groupId>com.wm</groupId>

35. <artifactId>offical-manager-service</artifactId>

36. <type>jar</type>

37. </dependency>

38. <dependency>

39. <groupId>com.wm</groupId>

40. <artifactId>official-manager-core</artifactId>

41. <type>jar</type>

42. </dependency>

43. <dependency>

44. <groupId>com.wm</groupId>

45. <artifactId>offical-common</artifactId>

46. <type>jar</type>

47. </dependency>

48. <!-- mysql資料庫驅動 -->

49. <dependency>

50. <groupId>mysql</groupId>

51. <artifactId>mysql-connector-java</artifactId>

52. <version>5.1.37</version>

53. </dependency>

54.  

55. <!--後臺許可權控制框架-->

56. <dependency>

57. <groupId>org.apache.shiro</groupId>

58. <artifactId>shiro-core</artifactId>

59. <version>${shiro-version}</version>

60. </dependency>

61. <dependency>

62. <groupId>org.apache.shiro</groupId>

63. <artifactId>shiro-spring</artifactId>

64. <version>${shiro-version}</version>

65. </dependency>

66.  

67. </dependencies>

68.  
69.  

70. <profiles>

71. <profile>

72. <id>local</id><!-- 本地開發環境 -->

73. <properties>

74. <package.env>local</package.env>

75. </properties>

76. <activation>

77. <activeByDefault>true</activeByDefault>

78. </activation>

79. </profile>

80. <profile>

81. <id>product</id><!-- 生產環境 -->

82. <properties>

83. <package.env>product</package.env>

84. </properties>

85. </profile>

86. </profiles>

87.  
88.  

89. <build>

90. <finalName>${project.artifactId}</finalName>

91.  

92. <resources>

93. <resource>

94. <directory>src/main/resources</directory>

95. <filtering>true</filtering>

96. <excludes>

97. <exclude>local/*</exclude>

98. <exclude>product/*</exclude>

99. </excludes>

100. <includes>

101. <include>public/**/*</include>

102. </includes>

103. </resource>

104. <resource>

105. <directory>src/main/java</directory>

106. <includes>

107. <include>com/wm/back/entity/**/hbm/*.hbm.xml</include>

108. </includes>

109. </resource>

110. </resources>

111. <plugins>

112. <!-- jetty外掛 -->

113. <plugin>

114. <groupId>org.eclipse.jetty</groupId>

115. <artifactId>jetty-maven-plugin</artifactId>

116. <version>9.3.8.v20160314</version>

117. <configuration>

118. <webAppConfig>

119. <contextPath>/</contextPath>

120. <defaultsDescriptor>src/main/resources/public/webdefault.xml</defaultsDescriptor>

121. </webAppConfig>

122. </configuration>

123. </plugin>

124.  
125.  

126. <plugin>

127. <groupId>org.apache.maven.plugins</groupId>

128. <artifactId>maven-war-plugin</artifactId>

129. <version>2.1.1</version>

130. <configuration>

131. <archive>

132. <addMavenDescriptor>false</addMavenDescriptor>

133. </archive>

134. <warName>${project.artifactId}</warName>

135. <webResources>

136. <!-- 不同的環境，使用不同的配置檔案 -->

137. <resource>

138. <directory>src/main/resources/${package.env}</directory>

139. <targetPath>WEB-INF/classes/${package.env}</targetPath>

140. <filtering>true</filtering>

141. </resource>

142. <!-- 公共的配置檔案 -->

143. <resource>

144. <directory>src/main/resources/public</directory>

145. <!--targetPath用來指定檔案放到哪裡-->

146. <targetPath>WEB-INF/classes/public</targetPath>

147. <filtering>true</filtering>

148. </resource>

149. <resource>

150. <directory>src/main/webapp/WEB-INF/config</directory>

151. <targetPath>WEB-INF</targetPath>

152. <filtering>true</filtering>

153. <includes>

154. <include>web.xml</include>

155. </includes>

156. </resource>

157. </webResources>

158. </configuration>

159. </plugin>

160.  
161.  

162. </plugins>

163. </build>

164. </project>

先貼出全部程式碼，然後再一一作出解釋

<profiles>
    <profile>
        <id>local</id><!-- 本地開發環境 -->
        <properties>
            <package.env>local</package.env>
        </properties>
        <activation>
            <activeByDefault>true</activeByDefault>
        </activation>
    </profile>
    <profile>
        <id>product</id><!-- 生產環境 -->
        <properties>
            <package.env>product</package.env>
        </properties>
    </profile>
</profiles>

properties裡配置的，下文都是可以使用的，我這裡配置package.env  ,所以下面使用package.env就是代表local或者product根據我傳入的 -P後面的那個值來決定
打包語句是mvn clean package -P +（我傳入的值 profile的id）來決定package.env的變數

完整的打包語句是mvn clean package -P local

<activeByDefault>true</activeByDefault>

來決定啟用哪個profile

<resources>
    <resource>
        <directory>src/main/resources</directory>
        <filtering>true</filtering>
        <excludes>
            <exclude>local/*</exclude>
            <exclude>product/*</exclude>
        </excludes>
        <includes>
            <include>public/**/*</include>
        </includes>
    </resource>
    <resource>
        <directory>src/main/java</directory>
        <includes>
            <include>com/wm/back/entity/**/hbm/*.hbm.xml</include>
        </includes>
    </resource>
</resources>

在我的理解下，不加resources的話，所有專案裡的resources檔案都會被載入，但java裡面的配置檔案可能還是載入不了的
但你定義了resources，你就要把你需要通過載入的檔案都要寫出來，不然他不會去載入。

我這裡把各環境的配置檔案都取消了載入，把通用的資原始檔進行了載入。

忘記提一句，這樣下，專案本地啟動的時候會報錯，因為你把local或product都去掉了，程式找不到裡面的檔案。這只是打包的時候才試用

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-war-plugin</artifactId>
    <version>2.1.1</version>
    <configuration>
        <archive>
            <addMavenDescriptor>false</addMavenDescriptor>
        </archive>
        <warName>${project.artifactId}</warName>
        <webResources>
            <!-- 不同的環境，使用不同的配置檔案 -->
            <resource>
                <directory>src/main/resources/${package.env}</directory>
                <targetPath>WEB-INF/classes/${package.env}</targetPath>
                <filtering>true</filtering>
            </resource>
            <!-- 公共的配置檔案 -->
            <resource>
                <directory>src/main/resources/public</directory>
                <!--targetPath用來指定檔案放到哪裡-->
                <targetPath>WEB-INF/classes/public</targetPath>
                <filtering>true</filtering>
            </resource>
            <resource>
                <directory>src/main/webapp/WEB-INF/config</directory>
                <targetPath>WEB-INF</targetPath>
                <filtering>true</filtering>
                <includes>
                    <include>web.xml</include>
                </includes>
            </resource>
        </webResources>
    </configuration>
</plugin>

打war包的時候需要這樣配置
directory:代表你要載入的目錄
targetPath:代表你要把你載入的檔案放在哪裡

<filtering>true</filtering>

這個網上說一定要設定為true，在我看來沒什麼關係，因為我根據命令打包，也能把檔案打出來

  <resource>
                <directory>src/main/webapp/WEB-INF/config</directory>
                <targetPath>WEB-INF</targetPath>
                <filtering>true</filtering>
                <includes>
                    <include>web.xml</include>
                </includes>
            </resource>

我這裡是為了把web.xml選擇讀哪個配置檔案給替換掉

為什麼要這樣設計能，因為如果不這樣，我們本地啟動專案，pom是不會吧${package.env}這個替換的。所以這樣會報錯。

但我們打包的時候希望靈活替換。所以就寫一個config檔案目錄，裡面放過web.xml，當要打包的時候替換WEB-INF下的web.xml檔案就可以了

到此，一個完整的流程就走完了