ant-design-pro使用qiankun微服務詳解

微服務現在挺火的,優點也很明顯

如果有多個應用都有相同頁面時,就可以使用微服務,可以避免重復寫代碼

 

在網上搜了下,很多例子都是基於官方文檔的例子,官方文檔: https://umijs.org/zh-CN/plugins/plugin-qiankun.比較簡單,實際使用場景會有特殊情況

我根據自己項目的情況總結了一下使用方法

 

我們兩個項目都是ant-design-pro的,我這里的例子也用的ant-design-pro項目生成的, githup地址: https://github.com/ant-design/ant-design-pro

 

微服務需要有主應用和子應用   一個子應用可以配置多個相關聯的主應用,配置方法都是一樣的

這是我的項目,一個主應用,一個子應用

 

首先,主應用和子應用都要安裝yarn add @umijs/plugin-qiankun -D

主應用配置

1. config.ts配置

 

2. app.tsx配置,這個entry,就是子應用的地址,可以寫成變量形式,區分本地和線上環境

 

3. 修改document.ejs文件,可以解決頁面一直加載問題

 

4. 修改routes文件

 

5. 配置proxy.tx接口代理.因為在主應用,請求的地址是主應用的,要代理回子應用的請求地址,如果已經有類似/api這種前綴,要注意主應用和子應用區分,不要用相同的前綴

 

子應用配置

1. config.ts配置

  qiankun: {
    slave: {},
  }

2. app.tsx配置.子應用可以通過生命周期函數拿到主應用傳遞的參數.如果子應用本身是有菜單,面包屑等,應該要區別,在主應用不顯示,否則會重復

let isMenu = true // 設置一個變量,判斷是否需要展示layout
// ProLayout 支持的api https://procomponents.ant.design/components/layout
export const layout: RunTimeLayoutConfig = ({ initialState }) => {
  console.log(initialState)
  const prop = {}
  if (!isMenu) { // 如果是加載在主應用中,不展示菜單和頭部
    prop.menuRender = false
    prop.headerRender = false
    prop.contentStyle = { margin: 0 }

  }
  return {
    rightContentRender: () => <RightContent />,
    disableContentMargin: false,
    waterMarkProps: {
      content: initialState?.currentUser?.name,
    },
    footerRender: () => <Footer />,
    headerContentRender: () => <ProBreadcrumb />,
    breadcrumbRender: (routers = []) => [
      {
        path: '/',
        breadcrumbName: '主頁',
      },
      ...routers,
    ],
    onPageChange: () => {
      const { location } = history;
      // 如果沒有登錄，重定向到 login
      if (!initialState?.currentUser && location.pathname !== loginPath) {
        history.push(loginPath);
      }
    },
    links: isDev
      ? [
          <Link to="/umi/plugin/openapi" target="_blank">
            <LinkOutlined />
            <span>OpenAPI 文檔</span>
          </Link>,
          <Link to="/~docs">
            <BookOutlined />
            <span>業務組件文檔</span>
          </Link>,
        ]
      : [],
    menuHeaderRender: undefined,
    // 自定義 403 頁面
    // unAccessible: <div>unAccessible</div>,
    ...prop,
    ...initialState?.settings,
  };
};

export const qiankun = {
  // 應用加載之前
  async bootstrap(props: any) {
    console.log('app1 bootstrap', props);
    if (props) {
      isMenu = props.isMenu
      const logins = async() => {
        await login({ ...props.accountInfo })
      }
      logins()
    }
  },
  // 應用 render 之前觸發
  async mount(props: any) {
    console.log('app1 mount', props);
  },
  // 應用卸載之后觸發
  async unmount(props: any) {
    console.log('app1 unmount', props);
  },
}

3.routes.ts文件,正常配置路由就可以了

...
{
    name: 'Form表單',
    icon: 'form',
    path: '/form',
    routes: [
      {
        path: '/form',
        redirect: '/form/add'
      },
      {
        name: 'form表單',
        icon: 'table',
        path: '/form/add',
        component: './product/addProduct',
      },
      {
        name: 'debonceselect',
        icon: 'table',
        path: '/form/debonceselect',
        component: './form/debounce',
      },
      {
        name: 'upload上傳',
        icon: 'table',
        path: '/form/upload',
        component: './form/upload',
      },
      {
        name: 'child詳情頁',
        icon: 'table',
        path: '/form/detail', // 主應用配置時路由要和子應用一致
        component: './form/detail',
      },
      {
        name: 'child詳情頁2',
        icon: 'table',
        path: '/form/detail2',
        component: './form/detail2',
      }
    ],
  },

4. proxy.ts文件

export default {
  dev: {
    '/childapi/api/': {
      target: 'http://localhost:8091',
      changeOrigin: true,
      pathRewrite: { '^/childapi': '' },
    },
  },
  test: {
    '/api/': {
      target: 'https://preview.pro.ant.design',
      changeOrigin: true,
      pathRewrite: { '^': '' },
    },
  },
  pre: {
    '/api/': {
      target: 'your pre url',
      changeOrigin: true,
      pathRewrite: { '^': '' },
    },
  },
};

 

運行效果

主應用頁面:

 

子應用頁面:

 

幾個項目實際要解決的問題

1. 子應用登錄態問題

如果子應用不需要登錄,只是查看可以忽略這個問題

如果主應用和子應用都有自己的登錄態.如果不做任何處理,想要在主應用運行子應用,必須要同時運行子應用,並且子應用要登錄,這樣不太合理

一般處理,主應用傳遞token,在子應用請求時加上這個token

let token = ''
const middleware: OnionMiddleware = async (ctx, next) => {
  const {
    req: { url },
  } = ctx

  ctx.req.options.headers = { // 在請求頭加入傳遞的token
    token,
  }

  await next()

  if (ctx.res.responseCode !== '000000') {
    if (!(ctx.res && ctx.res.size)) throw { ...ctx.res, url }
  }
}

export const qiankun = {
  // 應用加載之前
  async bootstrap(props: any) {
    if (props) {
      token = props.token
    }
  },
  // 應用 render 之前觸發
  async mount(props: any) {
    console.log('app1 mount', props)
  },
  // 應用卸載之后觸發
  async unmount(props: any) {
    console.log('app1 unmount', props)
  },
}

export const request: RequestConfig = {
  prefix: URL_PREFIX,
  method: 'POST',
  middlewares: [middleware],
  credentials: 'include',
  errorHandler,
}

我這個例子因為用的官方的項目,直接模擬了下,調用了子應用的登錄接口

export const qiankun = {
  // 應用加載之前
  async bootstrap(props: any) {
    console.log('app1 bootstrap', props);
    if (props) {
      isMenu = props.isMenu
      const logins = async() => { // 調用登錄接口
        await login({ ...props.accountInfo }) // 傳遞賬戶信息過來
      }
      logins()
    }
  },
  // 應用 render 之前觸發
  async mount(props: any) {
    console.log('app1 mount', props);
  },
  // 應用卸載之后觸發
  async unmount(props: any) {
    console.log('app1 unmount', props);
  },
}

這樣不用打開子應用也能加載子應用頁面了

 

2. 子應用運行時,會自動添加前綴

因為qiankun框架的代碼切割,子應用運行時會根據package.json里的name加入一個前綴.如果不想要可以在config.ts里配置base: '/'.我這里是換了一個前綴名稱

 

 

3. 子應用路由匹配問題.為了主應用的路由地址和子應用一致,配置路由時microAppProps的base傳了''

這樣會導致子應用頁面加載錯誤或登錄態失效時,頁面顯示404頁面.因為現在是精確的路由匹配,沒有登錄會重定向到登錄頁,這樣就會找不到頁面.一般設置好登錄態不會有這個問題,不過想要完善點,可以寫上錯誤路由跳轉到登錄頁面,或者提示刷新頁面等

 

githup代碼地址,

主應用:   https://github.com/shengbid/antpro-parent

子應用:   https://github.com/shengbid/antpro-child

 

如果遇到跟着文檔配置,項目啟動報錯問題,可能是項目運行問題,可以嘗試重啟,刪包重裝.在加入qiankun組件前,可以備份代碼,配置運行好后再加入代碼中, 以免出現代碼運行不了,恢復不了情況o(╯□╰)o

微服務其實有很多功能,不過目前也只用了些簡單的功能.如果有其他業務場景,可以留言,共同學習進步呀(*^▽^*)

最近新寫了一篇關於子應用動態配置成主應用主題色的方法,有需要可以看看 https://www.cnblogs.com/steamed-twisted-roll/p/15754035.html