欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

详解Vue.js项目API、Router配置拆分实践

程序员文章站 2023-08-16 18:28:35
前后端分离开发方式前端拥有更高的控制权 随着前端框架技术的飞速发展,router这个概念也被迅速普及到前端项目中,在早期前后的没有分离的时期下,并没有明确的路由概念,前端...

前后端分离开发方式前端拥有更高的控制权

随着前端框架技术的飞速发展,router这个概念也被迅速普及到前端项目中,在早期前后的没有分离的时期下,并没有明确的路由概念,前端页面跳转大多是通过后端进行请求转发的,比如在spring mvc项目中,进行一个页面跳转如下(画红线部分):

详解Vue.js项目API、Router配置拆分实践

前端需要一个超链接,链接的href=/manager,这样这个超链接被转发到scs/waitfollowed路径指定的页面。

前后的分离后,前端页面跳转的方式发生了变化,不再需要后端处理了,数据交换方式也改变了,由此前端需要定义router配置文件,需要定义api配置文件。在项目的权限配置管理中,完全不需要后端什么事了,可以说,权限配置表可以单独拿出来由前端维护了。

详解Vue.js项目API、Router配置拆分实践

比如这个url字段,在前后端不分离的情况下,严重依赖于后端,url就是后端接口地址,如果需要更改就需要后端修改代码修改接口地址,而现在,前端可以*控制url的值是什么了。

在接口层面,前端也会有自己的配置文件,可以对后端提供的接口进行重命名,组合等。比如

详解Vue.js项目API、Router配置拆分实践

前端都统一使用模块名+接口名的方式管理,管后端提供的接口叫啥已经不重要,在视觉上和维护上都比较方便。在页面上使用,查询起来也很直观:

详解Vue.js项目API、Router配置拆分实践

看到distrbute().leads.datagrid这个接口,就知道这是distrbute模块下leasd功能下的列表查询接口

vue.js中的api、router配置

在vue.js项目下,一开始我们只使用一个api.config.js配置文件,所有的接口都定义在这里面,router也一样,都配置在一个router.config.js中,下面是我们项目中api配置文件

详解Vue.js项目API、Router配置拆分实践

可以看到,很多的业务模块,很多的接口,已经达到了570多行,随着业务进一步推进,接口快速膨胀,文件越来越大。

这时候迫切需要拆分,把不同的业务模块单独拆分为一个个api配置文件。同样,我们来看看拆分前的router配置文件:

详解Vue.js项目API、Router配置拆分实践

这样router一多最大的缺点就是会导致router命名冲突。

拆分!拆分!拆分!

首先考虑api配置文件怎么拆分,对于接口,我们肯定有多套环境,多套环境那么api的url也不一样,拆分成多个文件后多个文件需要共用同一个获取apibase的方法,所以这个apibase就要写在公共的地方,在这里原来的api.config.js就变成了公共配置,apibase就放在此文件内。

export function apibase() {
 let hostname = window.location.hostname,
  api_base_url = 'http://test2api.dunizb.com';//默认环境
 if(hostname === 'crm.dunizb.cn') { //正式环境
  api_base_url = 'http://api.dunizb.cn';
 } else if(hostname === 'admin.dunizb.com') {//公网测试环境
  api_base_url = 'http://testapi.dunizb.com';
 } else if(hostname === 'manager.dunizb.com') {//内网测试环境
  api_base_url = 'http://test2api.dunizb.com';
 }
 return api_base_url;
}

然后在每个子api配置文件中引入即可:

import {apibase} from '../api.config';

具体功能api不需要更改,直接拷贝相应模块api到子模块api配置文件即可。

详解Vue.js项目API、Router配置拆分实践

router的拆分稍微复杂一点,拆分后的文件目录与api的目录相同:

详解Vue.js项目API、Router配置拆分实践

拆分思路也完全一样,但要保证只有一个router.start即:

return router.start(app, '#app');

虽然你在子router配置文件中也写上页面是能正常工作的,但是vue.js会在控制台报一个错误:

详解Vue.js项目API、Router配置拆分实践

这个错误的意思就是router已经启动,无需启动多次。所以,子router文件中不能存在 return router.start(app, '#app'); 这样的代码。

拆分后router.config.js内容如下:

/**
 * 路由总文件
 * created by bing on 2017/6/19 0019.
 */
import app from './app';
import authority from './routers/authority';
import publics from './routers/public';
import study from './routers/study';
... ...
export default function(router){
 authority(router);//基础与权限模块
 publics(router);//公共模块
 study(router);//教学相关
 ... ...
 return router.start(app, '#app');
}

而子router配置文件的写法就是这样(以study模块为例):

/**
 * 教学排课
 * 教研
 * created by bing on 2017/6/19 0019.
 */
import courseindex from 'components/studycourse/index/index';
import waitcourse from 'components/studycourse/waitcourse/waitcourse';
import alreadycourse from 'components/studycourse/alreadycourse/alreadycourse';
import gearcourse from 'components/studycourse/waitcourse/gearcourse';
import courseware from 'components/teachingresearch/courseware/courseware.vue';
import coursewarelibrary from 'components/teachingresearch/courseware/library.vue';
export default function(router) {
 router.map({
  '/study/index': {component: courseindex},
  '/study/waitcourse': {component: waitcourse},//待排课程
  '/study/waitcourse/gearcourse': {component: gearcourse},//待排
  '/study/course': {component: alreadycourse},//已排课程
  '/tr/courseware': {component: courseware},//课件管理
  '/tr/courseware/library': {component: coursewarelibrary},//自主上传课件库
 });
}

拆分后,每个模块管理它自己领域的router、api,router.config.js和api.config.js就大大瘦身了,也降低了命名冲突的问题和将来混乱的问题。

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。