草庐IT

项目里的各种配置,你都了解吗?

Java技术栈 2023-04-16 原文

来源:https://lepdou.github.io/blogs/config/config.html

引言

项目开发中总是有各种各样的配置,对于程序开发新手来说,配置是摆在面前的第一座大山。 回想当年在学校学习经典的“SSH”的时候,一个web.xml配置都是异常的艰辛。工作多年的你,对配置真的了解吗?

什么是配置?

首先我们来看一下配置文件的定义:

“A software file used to configure the initial settings for a computer program.” -- From wikipedia

配置来源可能有以下这些:

  1. 硬编码参数
  2. 项目里的配置文件
  3. 文件系统上的配置文件
  4. 网络上的配置文件
  5. 启动参数(JVM属性)
  6. 操作系统参数

下面会详细介绍每一种配置类型的使用场景。

硬编码参数

最常见的就是定义静态变量方式。例如: public static final int PAGE_SIZE = 10;
另外就是通过框架暴露的各种API接口设置参数。

优点
  • 这种是最简单、成本最低的方式
  • 不用额外创建文件
  • 代码里能直接能读取
  • 离配置使用地方最近的一种方式
缺点
  • 代码和配置糅合在一起,不易于维护
  • 修改配置必须修改源代码,重新编译、打包、上线
  • 同一个框架的配置散落到项目各个角度,不利于查找
适用场景
  • Hard Code 适用于配置极其简单且几乎不会变更
  • 为了赋予常量语义
  • 配置极少从而创建配置文件成本高

项目里配置文件

这种方式是最常见的。标准的maven项目有一个resources目录就是用来放置各种类型的配置文件,例如:

  • web项目的web.xml
  • log框架的配置
  • spring的bean定义的xml文件
  • mybatis的sql配置文件
  • spring boot的application.yml application.properties
  • 自定义的properties文件

另外maven项目的核心pom.xml也算是配置文件。项目里使用到的各种各样的框架、中间件基本上都需要配置文件来支撑。框架在运行时,读取配置文件来决定运行时的行为。 配置文件路径一般有两种方式:

  • 按照框架约定的目录(相对于classpath)
  • 告诉框架配置文件的路径
优点
  • 配置和代码分离
  • 集中统一管理配置
  • 不依赖项目外部资源
缺点
  • 跟Hard Code一样不能动态修改配置
  • 配置文件增生,导致项目臃肿
适用场景
  • 非常适合框架或者中间件的配置
  • 项目中自定义业务配置

文件系统上的配置文件

此类配置文件是放在应用运行的机器上。常见的比如携程公司内部机器上都会放置一个server.properties文件。文件内容主要是当前机器的一些信息,比如env=dev标示当前机器属于dev环境。公司配套提供framework-fundation基础jar包,用来解析这个文件。

那么应用只要通过framework-foundation来获取机器的相关信息。 framework-foundation在这里的作用就是作为机器和应用之间的桥梁。这种方式主要好处是规范运维。 另外一种使用比较多的场景是应用直接读取文件系统上的某个文件。这种方式的好处就是可以动态更新配置,无需重新编译、打包、运行应用。

优点
  • 配置和代码分离
  • 可动态修改配置
缺点
  • 配置和应用代码不在一个地方(项目源码),不易于理解和运行
  • 修改配置需要登录机器
  • 修改配置文件可能涉及权限问题
  • 配置文件路径也需要沟通
适用场景
  • 不建议作为应用业务相关的配置,成本高且不易于开发维护
  • 适用于运维相关的配置,如前面举的例子

笔者遇到过一个dal框架,datasource配置文件就是放在文件系统上,结果开发人员在上线时,忘记在机器上放置这个文件导致线上bug。

网络上的配置文件

常见的包括两种:DB上的配置表、配置中心。如果公司没有统一的配置中心,那么最简单的动态修改配置的方式莫过于把配置放置在DB上。相信大部分的开发都使用过或者遇到过。

配置中心是最适合集中化管理配置、动态修改配置的地方。常见的配置中心都会提供管理配置后台、实时推送配置、分环境管理配置、配置版本管理等。笔者目前就在开发一款开源的配置中心系统。

优点
  • 集中管理配置、全方位管理配置
  • 动态修改配置、实时推送、更新配置
  • 配置更加灵活,例如可以分环境、集群以及灰度发布等
缺点
  • 需要依赖数据库或者配置中心,成本高
适用场景
  • 经常需要变更的配置
  • 配置值每个环境不一致
  • 不希望配置值随着代码一起发布,例如开源项目中的某些配置

启动参数(JVM属性)

JVM属性主要是应用运行的JVM进程相关的属性,比如java.class.version、java.class.path等Java相关的参数。在代码里,可以通过System.getProperty()获取参数值。 另外,可以通过在启动时指定-D参数来设置JVM属性。最常见的使用场景是用来解决不同环境需要配置不同的参数。例如作为中间件,依赖的外部系统越少越好,如果不依赖配置中心,那么就可以通过这种方式来实现不同环境配置不同的参数,例如每个环境的数据库连接串不一样。 另外需要提到的是maven打包参数。

相比于-D运行时参数,maven打包参数是在编译时设置配置属性,maven会获取打包参数然后替换掉配置文件里的placeholder。假设一个可运行的jar包,只需要在打包的时候传入参数值,打出来的jar包就可以到处运行了,如果不这么做,那么需要每次运行的时候指定参数,成本太高。使用方式则是在mvn package 时指定-D参数。 新手很容易混淆这两种参数。换个角度看-D是命令行参数。

优点
  • 以非常小的代价就可以达到运行时指定特殊参数值
缺点
  • 启动运行项目需要设置启动参数,增加使用成本
适用场景
  • 适合中间件类系统,不推荐业务系统使用(业务系统用配置中心解决此类场景)
  • 增加统一运维成本

操作系统参数

操作系统参数一般是只读的,当然也可以设置。例如前面提到的server.properties文件里的env参数,其实也可以作为系统参数,但是不建议这么做。

后记

配置的好处显而易见,但是我们在工作中经常会遇到这种情况。拿到一个项目,看到乱七八糟的配置无从下手,项目中使用的框架、中间件配置风格更不相同,更头疼的是配置项如果不了解框架的基础上很难理解。

导致的结果就是如果不复制、粘贴配置,手写配置基本上很难写对。 验证这种情况最简单的方式就是不复制其它项目的配置,手动搭建一个新项目。我相信绝大多数的人都难以做到。

片面的说学习一个框架其实是在学习这个框架的API和配置参数。如果你非常熟悉一个框架的配置,那么你对框架的使用就得心应手了。当然,知道框架的原理也非常重要。 说这么多,只想说明项目的配置真的非常重要,更好的管理、规范配置更加重要。

对于框架、中间件开发者来说,配置应该越少越好,增加一个配置对于使用者使用成本就会大大提高。如果配置很多,那么你的框架基本上就是很难用了。 Spring一直是Java界最权威的框架体系,最新的Spring Boot框架的配置就非常少,一眼看上去非常舒心。

Spring现在倡导减少配置文件,例如Spring早期版本的xml配置其实是很繁琐的。新的Spring更多的配置放置在代码中,利用注解以及API方式配置。Servlet最新版本也不需要web.xml文件了。

说明一个道理: 大道至简?

近期热文推荐:

1.1,000+ 道 Java面试题及答案整理(2022最新版)

2.劲爆!Java 协程要来了。。。

3.Spring Boot 2.x 教程,太全了!

4.别再写满屏的爆爆爆炸类了,试试装饰器模式,这才是优雅的方式!!

5.《Java开发手册(嵩山版)》最新发布,速速下载!

觉得不错,别忘了随手点赞+转发哦!

有关项目里的各种配置,你都了解吗?的更多相关文章

  1. ruby - 如何在 buildr 项目中使用 Ruby 代码? - 2

    如何在buildr项目中使用Ruby?我在很多不同的项目中使用过Ruby、JRuby、Java和Clojure。我目前正在使用我的标准Ruby开发一个模拟应用程序,我想尝试使用Clojure后端(我确实喜欢功能代码)以及JRubygui和测试套件。我还可以看到在未来的不同项目中使用Scala作为后端。我想我要为我的项目尝试一下buildr(http://buildr.apache.org/),但我注意到buildr似乎没有设置为在项目中使用JRuby代码本身!这看起来有点傻,因为该工具旨在统一通用的JVM语言并且是在ruby中构建的。除了将输出的jar包含在一个独特的、仅限ruby​​

  2. ruby-on-rails - 独立 ruby​​ 脚本的配置文件 - 2

    我有一个在Linux服务器上运行的ruby​​脚本。它不使用rails或任何东西。它基本上是一个命令行ruby​​脚本,可以像这样传递参数:./ruby_script.rbarg1arg2如何将参数抽象到配置文件(例如yaml文件或其他文件)中?您能否举例说明如何做到这一点?提前谢谢你。 最佳答案 首先,您可以运行一个写入YAML配置文件的独立脚本:require"yaml"File.write("path_to_yaml_file",[arg1,arg2].to_yaml)然后,在您的应用中阅读它:require"yaml"arg

  3. ruby-on-rails - 项目升级后 Pow 不会更改 ruby​​ 版本 - 2

    我在我的Rails项目中使用Pow和powifygem。现在我尝试升级我的ruby​​版本(从1.9.3到2.0.0,我使用RVM)当我切换ruby​​版本、安装所有gem依赖项时,我通过运行railss并访问localhost:3000确保该应用程序正常运行以前,我通过使用pow访问http://my_app.dev来浏览我的应用程序。升级后,由于错误Bundler::RubyVersionMismatch:YourRubyversionis1.9.3,butyourGemfilespecified2.0.0,此url不起作用我尝试过的:重新创建pow应用程序重启pow服务器更新战俘

  4. ruby-on-rails - 新 Rails 项目 : 'bundle install' can't install rails in gemfile - 2

    我已经像这样安装了一个新的Rails项目:$railsnewsite它执行并到达:bundleinstall但是当它似乎尝试安装依赖项时我得到了这个错误Gem::Ext::BuildError:ERROR:Failedtobuildgemnativeextension./System/Library/Frameworks/Ruby.framework/Versions/2.0/usr/bin/rubyextconf.rbcheckingforlibkern/OSAtomic.h...yescreatingMakefilemake"DESTDIR="cleanmake"DESTDIR="

  5. Ruby Sinatra 配置用于生产和开发 - 2

    我已经在Sinatra上创建了应用程序,它代表了一个简单的API。我想在生产和开发上进行部署。我想在部署时选择,是开发还是生产,一些方法的逻辑应该改变,这取决于部署类型。是否有任何想法,如何完成以及解决此问题的一些示例。例子:我有代码get'/api/test'doreturn"Itisdev"end但是在部署到生产环境之后我想在运行/api/test之后看到ItisPROD如何实现? 最佳答案 根据SinatraDocumentation:EnvironmentscanbesetthroughtheRACK_ENVenvironm

  6. Ruby 从大范围中获取第 n 个项目 - 2

    假设我有这个范围:("aaaaa".."zzzzz")如何在不事先/每次生成整个项目的情况下从范围中获取第N个项目? 最佳答案 一种快速简便的方法:("aaaaa".."zzzzz").first(42).last#==>"aaabp"如果出于某种原因你不得不一遍又一遍地这样做,或者如果你需要避免为前N个元素构建中间数组,你可以这样写:moduleEnumerabledefskip(n)returnto_enum:skip,nunlessblock_given?each_with_indexdo|item,index|yieldit

  7. ruby - 是否有用于序列化和反序列化各种格式的对象层次结构的模式? - 2

    给定一个复杂的对象层次结构,幸运的是它不包含循环引用,我如何实现支持各种格式的序列化?我不是来讨论实际实现的。相反,我正在寻找可能会派上用场的设计模式提示。更准确地说:我正在使用Ruby,我想解析XML和JSON数据以构建复杂的对象层次结构。此外,应该可以将该层次结构序列化为JSON、XML和可能的HTML。我可以为此使用Builder模式吗?在任何提到的情况下,我都有某种结构化数据-无论是在内存中还是文本中-我想用它来构建其他东西。我认为将序列化逻辑与实际业务逻辑分开会很好,这样我以后就可以轻松支持多种XML格式。 最佳答案 我最

  8. Vscode+Cmake配置并运行opencv环境(Windows和Ubuntu大同小异) - 2

    之前在培训新生的时候,windows环境下配置opencv环境一直教的都是网上主流的vsstudio配置属性表,但是这个似乎对新生来说难度略高(虽然个人觉得完全是他们自己的问题),加之暑假之后对cmake实在是爱不释手,且这样配置确实十分简单(其实都不需要配置),故斗胆妄言vscode下配置CV之法。其实极为简单,图比较多所以很长。如果你看此文还配不好,你应该思考一下是不是自己的问题。闲话少说,直接开始。0.CMkae简介有的人到大二了都不知道cmake是什么,我不说是谁。CMake是一个开源免费并且跨平台的构建工具,可以用简单的语句来描述所有平台的编译过程。它能够根据当前所在平台输出对应的m

  9. 神州数码无线产品(AC+AP)配置 - 2

    注意:本文主要掌握DCN自研无线产品的基本配置方法和注意事项,能够进行一般的项目实施、调试与运维AP基本配置命令AP登录用户名和密码均为:adminAP默认IP地址为:192.168.1.10AP默认情况下DHCP开启AP静态地址配置:setmanagementstatic-ip192.168.10.1AP开启/关闭DHCP功能:setmanagementdhcp-statusup/downAP设置默认网关:setstatic-ip-routegeteway192.168.10.254查看AP基本信息:getsystemgetmanagementgetmanaged-apgetrouteAP配

  10. hadoop安装之保姆级教程(二)之YARN的配置 - 2

    1.1.1 YARN的介绍 为克服Hadoop1.0中HDFS和MapReduce存在的各种问题⽽提出的,针对Hadoop1.0中的MapReduce在扩展性和多框架⽀持⽅⾯的不⾜,提出了全新的资源管理框架YARN. ApacheYARN(YetanotherResourceNegotiator的缩写)是Hadoop集群的资源管理系统,负责为计算程序提供服务器计算资源,相当于⼀个分布式的操作系统平台,⽽MapReduce等计算程序则相当于运⾏于操作系统之上的应⽤程序。 YARN被引⼊Hadoop2,最初是为了改善MapReduce的实现,但是因为具有⾜够的通⽤性,同样可以⽀持其他的分布式计算模

随机推荐