uniapp 区分环境打包配置

Posted 织_网

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了uniapp 区分环境打包配置相关的知识,希望对你有一定的参考价值。

概述

在开发web时,有时需要一套代码编译发布到不同的站点,比如主站和微信h5站。(注意不是一套代码内部自适应不同浏览器,是真的分离部署了不同的网站)
在开发小程序时,经常有扩展小程序平台,比如基于阿里小程序的钉钉小程序、淘宝小程序。
uni-app 通过在package.json文件中增加uni-app扩展节点,可实现自定义条件编译平台。

扩展新的平台后,有3点影响:

  • 可以在代码里编写自定义的条件编译,为这个新平台编写专用代码
  • 运行时可以执行面向新平台的编译运行
  • 发行时可以执行面向新平台的编译发行

注意

只能扩展web和小程序平台,不能扩展app打包。并且扩展小程序平台时只能基于指定的基准平台扩展子平台,不能扩展基准平台。基准平台详见下文。

package.json扩展配置用法:

如果没有package.json,通过命令npm init -y创建。
删除package.json 初始化配置 ; 直接复制底下代码

属性

  • UNI_PLATFORM仅支持填写uni-app默认支持的基准平台,目前仅限如下枚举值:h5、mp-weixin、mp-alipay、mp-baidu、mp-toutiao、mp-qq
  • BROWSER 仅在UNI_PLATFORM为h5时有效,目前仅限如下枚举值:chrome、firefox、id、edge、safari、hbuilderx
  • env 环境变量
  • title 自定义环境的标题,可以在HBuliderX运行菜单下展示
  • define 自定义条件编译;自定义条件编译常量,建议为大写
  • UNI_BASE_URL 自定义全局请求路径

	"uni-app": 
		"scripts": 
			"dev-h5": 
				"title": "开发版H5",
				"BROWSER": "chrome",
				"env": 
					"UNI_PLATFORM": "h5",
					"UNI_BASE_URL": "/host"
				,
				"define": 
					"DEV-H5": true
				
			,
			"pre-h5": 
				"title": "测试版H5",
				"BROWSER": "chrome",
				"env": 
					"UNI_PLATFORM": "h5",
					"UNI_BASE_URL": "https://test.XXX.XXX.com"
				,
				"define": 
					"PRE-H5": true
				
			,
			"prod-h5": 
				"title": "正式版H5",
				"BROWSER": "chrome",
				"env": 
					"UNI_PLATFORM": "h5",
					"UNI_BASE_URL": "https://XXX.XXX.com"
				,
				"define": 
					"PROD-H5": true
				
			,
			"devwx": 
				"title": "开发版微信小程序",
				"env": 
					"UNI_PLATFORM": "mp-weixin",
					"UNI_BASE_URL": "https://test.XXX.XXX.com"
				
			,
			"prewx": 
				"title": "测试版微信小程序",
				"env": 
					"UNI_PLATFORM": "mp-weixin",
					"UNI_BASE_URL": "https://test.XXX.XXX.com"
				
			,
			"prodwx": 
				"title": "正式版微信小程序",
				"env": 
					"UNI_PLATFORM": "mp-weixin",
					"UNI_BASE_URL": "https://XXX.XXX.com"
				
			
		
	

//新建文件 config.js
module.exports = 
	baseUrl: process.env.UNI_BASE_URL,

运行

打包部署

注意

  • package.json文件中不允许出现注释,否则扩展配置无效,将注释删除,否则会编译错误。
  • vue-cli需更新到最新版,HBuilderX需升级到 2.1.6+ 版本
  • 直接修改env 里面 BASE_URL字段的值 无效

错误示范

uniapp官网 package.json配置

uniapp 开发多端项目如何配置环境变量以及区分环境打包

前言


这边博文的前提是uniapp 是基于 vue3.0 + vite + HbuilderX 3.4.15.20220610 版本的背景下

  • 1,使用uniapp开发跨端项目时,我使用的是HbuilderX开发的,由于HbuilderX发布项目啥的都是点击菜单栏的发布,发布只能发布一个环境的,每次都得改代码切换环境变量,非常麻烦,也有可能漏掉,所以就研究了一下如何区分环境打包上线。
  • 2, 这时候就会有人问,为什么不用vue-cli开发打包项目啊,直接用.env文件或者`cross-env 区分环境变量,注意这里我的项目是要生成app的,所以不方便使用vue-cli,来开发。

解决方案

我在官方文档中看到了package.json扩展配置用法,这篇文章,可以很好的解决这个问题

  • 1, 这个方法也有缺陷,那就是不能在app上使用,只能用于网页和小程序。
  • 2, 我在网上看到有人提出使用appid区分环境,但是我自己试了一遍,发现每个环境的appid都是相同的,没有办法区分环境,这个方法也就被我废弃掉了。
  • 3,后来我自己想到,能不能像H5一样,我在app内做个切换环境的功能,虽然只能打一个包,但是包内可以切换环境,这样是不是就可以解决这个问题
  • 4,经过实践,我的想法得到了证实,可以采用。

第一步:安装package.json文件

如果你的项目中有这个文件,就忽略这一步,如果没有,就往下看。
使用npm init -y创建package.json文件,创建好后再项目根目录下就能找到这个文件

第二步:配置package.json文件

注意:官方文档中有说道,该文件中不能有注释,所以复制代码要把注释删掉。上边有文档传送门


  "name": "uniuiTemplate",
  "version": "1.0.0",
  "description": "",
  "main": "main.js",
  "scripts": 
    "test": "echo \\"Error: no test specified\\" && exit 1"
  ,
  "keywords": [],
  "author": "",
  "license": "ISC",
  // 下边就是所有的你可以配置的不同平台的各个环境变量的配置
  "uni-app": 
  		"scripts": 
			"h5dev":
				"title":"h5开发版",
				"browser":"chrome",  
				"env": 
				    "UNI_PLATFORM": "h5", //基准平台,必须写平台准许的值
					"VUE_APP_BASE_URL":"http://127.0.0.1:h5dev/"  //自定义环境变量
				,
				"define":
					"H5-DEV":true
				
			,
			"h5test":
				"title":"h5测试版",
				"browser":"chrome",  
				"env": 
				    "UNI_PLATFORM": "h5",
					"VUE_APP_BASE_URL":"http://127.0.0.1:h5test/",
					"MY_TEST":"test-variable"
				,
				"define":
					"H5-TEST":true
				
			,
			"h5prod":
				"title":"h5生产版",
				"browser":"chrome",  
				"env": 
				    "UNI_PLATFORM": "h5",
					"VUE_APP_BASE_URL":"http://127.0.0.1:h5prod/"
				,
				"define":
					"H5-PROD":true
				
			,
			"mp-weixin-dev":
				"title":"微信开发版",
				"env": 
				    "UNI_PLATFORM": "mp-weixin",
					"VUE_APP_BASE_URL":"http://127.0.0.1:mp-weixin-dev/"
				,
				"define":
					"MP-WEIXIN-DEV":true
				
			,
			"mp-weixin-test":
				"title":"微信测试版",
				"env": 
				    "UNI_PLATFORM": "mp-weixin",
					"VUE_APP_BASE_URL":"http://127.0.0.1:mp-weixin-test/"
				,
				"define":
					"MP-WEIXIN-TEST":true
				
			,
			"mp-weixin-prod":
				"title":"微信生产版",
				"env": 
				    "UNI_PLATFORM": "mp-weixin",
					"VUE_APP_BASE_URL":"http://127.0.0.1:mp-weixin-prod/"
				,
				"define":
					"MP-WEIXIN-PROD":true
				
			
  		
  	


第三步:配置package.json文件完成后的变化以及操作

配置完成后你就会发现HbuilderX编辑器多了一下环境变量,具体如下


运行

点击运行你会发现多了几个选项,如下图:然后你可以选择你想运行的环境进行开发。


发行

点击发行你会发现多了几个选项,如下图:然后你可以选择你想发行的环境进行部署或者上传代码。

结束语

到此,就可以使用hbuilderx开发或者发布不同的环境和平台,从此告别手动切换环境变量。


Tips: 这个配置使用vue-cli也是可以的。

以上是关于uniapp 区分环境打包配置的主要内容,如果未能解决你的问题,请参考以下文章

maven 开发环境与生产环境区分打包

VUE打包区分生产和测试环境

搭建reactJS 项目的时候 区分各种环境进行打包处理

vue中Npm run build 根据环境传递参数方法来打包不同域名

uniapp 开发多端项目如何配置环境变量以及区分环境打包

uniapp 开发多端项目如何配置环境变量以及区分环境打包