Ice飞冰目录结构&应用入口&工程配置&路由配置《四》

建一个icestark微前端项目的情况下，来看这些配置(搬官网)

目录结构：

├── .ice/ # 运行时生成的临时目录
├── build/ # 构建产物目录
├── mock/ # 本地模拟数据
│ ├── index.js
├── public/
│ ├── index.html # 应用入口 HTML
│ └── favicon.png # Favicon
├── src/ # 源码
│ ├── components/ # 自定义业务组件
│ ├── layouts/ # 布局组件
│ ├── pages/ # 页面
│ ├── models/ # 应用级数据状态
│ ├── global.scss # 全局样式
│ ├── config.ts # 环境配置
│ ├── routes.ts # 路由配置
│ └── app.ts # 应用入口
├── build.json # 应用的工程配置文件
├── package.json
└── tsconfig.json # TypeScript 编译所需的配置文件。

应用入口：

框架通过调用 runApp 创建渲染整个应用，在创建应用时可以传入应用的全局配置。

配置规范#

通过 src/app.ts 对应用进行全局配置，设置路由、运行环境、请求、日志等：

import { runApp, IAppConfig } from 'ice';
// 应用配置
const appConfig: IAppConfig = {
  app: {
    *// ...*
  },
  router: {
    *// ...*
  },
  store: {
    *// ...*
  },
  request: {
    *// ...*
  },
  logger: {
    *// ...*
  },
};
runApp(appConfig);

启动项配置#

app 这一项所支持的配置：

import { runApp } from 'ice';
const appConfig = {
  app: {
    // 可选，根节点 id，默认为 ice-container
    rootId: 'ice-container',
    // 可选，根节点 DOM 元素，更灵活的 rootId
    mountNode: document.getElementById('ice-container'),
    // 可选，是否解析路由组件的查询参数，默认 true
    parseSearchParams: true
    // 可选，自定义添加 Provider
    addProvider: ({ children }) => {
      return <ConfigProvider>{children}</ConfigProvider>;
    },
    // 可选，常用于 SSR 场景或者异步获取数据请求的场景
    // 如果返回字段中包含 initialStates 字段将会作为状态管理 store 的初始值
    // 如果返回字段中包含 auth 字段将会作为权限管理 auth 的初始值
    getInitialData: async() => {
      const result = await request();
      return result;
    },
    // 可选，自定义错误边界的 fallback UI
    ErrorBoundaryFallback: <div>渲染错误</div>,
    // 可选，自定义错误的处理事件
    onErrorBoundaryHander: (error, componentStack) {
      // Do something with the error
    },
    // 可选，用于渲染一个简单组件，不再需要耦合 react-router 的路由系统
    // 需要配合设置 build.json 的 router 项为 false
    renderComponent: SimpleComponent,
  },
};
runApp(appConfig);

工程配置：

如何开启新的 JSX 转换#

ice.js 1.16.0+ 支持 New JSX Transform，开启该能力之后，编写 React 组件时不再需要在头部引入 React。

只需要修改 tsconfig.json 中的 compilerOptions.jsx 即可：

{
  "compilerOptions": {
\-    "jsx": "react",
\+    "jsx": "react-jsx",
  }
}
//接下来书写组件就不再需要引入 React 了：
\- import React from 'react';
function Example() {
  return <>Hello</>;
}

自定义工程配置#

如果基础配置和已有插件都无法支持业务需求，可以通过自定义配置来实现，自定义配置同时也是一个 webpack 插件。

首先新建 build.plugin.js 文件作为一个自定义插件，然后写入以下代码：

module.exports = ({ context, onGetWebpackConfig }) => {
  onGetWebpackConfig((config) => {});
};

插件内部代码写法可以参考文档 通过插件定制工程能力。

最后在 build.json 里引入自定义插件即可：

{
  "plugins": ["build-plugin-ice-app", "./build.plugin.js"]
}

配置路由信息#

应用的路由信息统一在 src/routes.ts 中配置，配置协议支持多级嵌套，具体如下：

import UserLayout from '@/Layouts/UserLayout';
import UserLogin from '@/pages/UserLogin';
import NotFound from '@/components/NotFound';
import wrapperPage from '@/components/WrapperPage';

const routerConfig = [
  // 分组路由，children 里的路由会将父节点的 component 作为布局组件
  {
    path: '/user',
    component: UserLayout,
    children: [
      {
        // 路由路径
        path: '/login',
        // 精确匹配
        exact: true,
        // 路由组件
        component: UserLogin,
        // 配置路由的高阶组件
        wrappers: [wrapperPage],
      },
      {
        path: '/',
        // 重定向
        redirect: '/user/login',
      },
      {
        // 404 没有匹配到的路由
        component: NotFound,
      },
    ],
  },
  // 非分组路由
  {
    path: '/about',
    component: About,
  },
];
export default routerConfig;

注意：路由有一个按顺序匹配的规则，从上到下一旦命中路由匹配规则就会停止遍历，因此如果你在最前面配置了 / 这样一个路由，则所有的路由都会命中该规则，导致其他路由没有效果，所以在开发时要注意路由的顺序以及 exact 属性的使用。

运行时配置#

在 src/app.ts 中，我们可以配置路由的类型和基础路径等信息，具体配置如下：

import { runApp } from 'ice';
const appConfig = {
  router: {
    type: 'browser',
    basename: '/seller',
    fallback: <div>loading...</div>
    modifyRoutes: (routes) => {
      return routes;
    }
  }
};
runApp(appConfig);

options:

• type: 路由类型，默认值 hash，可选值 browser|hash|static
• basename: 路由基准地址
• fallback: 开启按需加载时配置 fallback UI
• modifyRoutes: 动态修改路由
• history: 自定义创建 history 对象，详见

路由组件参数#

对于路由组件（即页面级组件），可通过组件 props 获取到如下属性：

• location：当前路由的 location 对象，包含 pathname、search、hash、state 属性
• history：详见 history api
• searchParams：当前 URL 的查询参数对象（需要开启 parseSearchParams）
• match：当前路由和 URL match 后的对象，包含 path、url、params、isExact 属性

对于非路由组件，组件内如想获取上述属性需要借助 useHistory, useLocation, useParams, withRouter 等 API。

路由跳转#

通常使用 Link 组件或者 history API 进行路由的跳转：

import { Link, useHistory } from 'ice';

function Home() {
  const history = useHistory();
  return (
    <>
      <Link to="/about">去 about 页面</Link>
      <span
        onClick={() => {
          history.push('/about');
        }}
      >
        去 about 页面
      </span>
    </>
  );
}

路由跳转传递参数，除了通过 url params 如 /projects/:id 以及 url query 如 /project?id=1 以外，也可通过 state 参数：

注意：state 传递参数仅支持 BrowserHistory 不支持 HashHistory，通过 src/app.ts 里的 router.type 字段可配置。

import { Link, useHistory } from 'ice';

function Home() {
  const history = useHistory();
  return (
    <>
      <Link
        to={{
          pathname: '/about',
          state: { from: 'click link' },
        }}
      >
        去 about 页面
      </Link>
      <span
        onClick={() => {
          history.push({
            pathname: '/about',
            state: { from: 'click span' },
          });
        }}
      >
        去 about 页面
      </span>
    </>
  );
}

在 about 页面即可通过 location 访问到对应的 state：

import { useLocation } from 'ice';

function About() {
  const location = useLocation();
  console.log('history state', location.state);
  return <></>;
}

路由高阶组件#

通过 src/routes.ts 中的 wrappers 字段可配置路由的高阶组件，常用于路由级别的权限检验。

配置 wrappers#

+import WrapperPage from '@/components/WrapperPage';
const routerConfig = [
  {
    path: '/user',
    component: User,
    // 配置路由的高阶组件
+    wrappers: [WrapperPage]
  },
]

注意：Wrapper 组件不支持通过 lazy 导入

实现高阶组件#

// src/components/LoginWrapper
import { useAuth, Redirect } from 'ice';

const LoginWrapper = (WrappedComponent) => {
  const Wrapped = (props) => {
    const [auth] = useAuth();
    return <>{auth.isLogin ? <WrappedComponent {...props} /> : <Redirect to="/login" />}</>;
  };

  return Wrapped;
};

export default LoginWrapper;

通过 wrappers 配置我们可以对路由组件进行自定义包装，如上示例通过 WrapperPage 高阶组件对路由组件进行权限判断，如果是登录状态，则渲染 User 组件，否则跳转到 /login 路由。

useAuth API 需要结合 plugin-ice-auth 插件实现，可参考 权限管理 。

如何使用动态路由#

在某些场景下可能需要动态指定路由即 /user/:id，使用方式如下：

路由配置：

import UserInfo from '@/pages/UserInfo';

// src/routes.ts
const routerConfig = [
  {
    path: '/user/:id',
    exact: true,
    component: UserInfo,
  },
];

动态路由参数：

import { useParams } from 'ice';

export default = () => {
  const { id } = useParams();
  // console.log(id) // 123
}