fix: excel download json response error

composer.json

@@ -18,7 +18,7 @@
         "guzzlehttp/guzzle": "^7.2",
         "laravel/framework": "^10.0",
         "laravel/tinker": "^2.8",
-        "catchadmin/core": "^0.1.14"
+        "catchadmin/core": "^0.2.1"
     },
     "require-dev": {
         "fakerphp/faker": "^1.9.1",

modules/Develop/Support/Generate/stubs/migration.stub

@@ -13,6 +13,8 @@ return new class extends Migration
      */
     public function up()
     {
+        if (Schema::hasTable('{table}')) { return; }
+
         Schema::{method}('{table}', function (Blueprint $table) {
             {content}
         });

modules/User/Http/Controllers/UserController.php

@@ -159,4 +159,16 @@ class UserController extends Controller
             return $builder;
         })->getList();
     }
+
+    /**
+     * @return void
+     */
+    public function export()
+    {
+        return User::query()
+                    ->select('id', 'username', 'email', 'created_at')
+                    ->without('roles')
+                    ->get()
+                    ->download(['id', '昵称', '邮箱', '创建时间']);
+    }
 }

modules/User/routes/route.php

@@ -14,4 +14,8 @@ Route::put('users/enable/{id}', [UserController::class, 'enable']);
 Route::match(['post', 'get'], 'user/online', [UserController::class, 'online']);
 Route::get('user/login/log', [UserController::class, 'loginLog']);
 Route::get('user/operate/log', [UserController::class, 'operateLog']);
+Route::get('user/operate/log', [UserController::class, 'operateLog']);
+Route::get('user/export', [UserController::class, 'export']);
+
+
 

modules/User/views/user/index.vue

@@ -16,7 +16,11 @@
         </template>
       </Search>
       <div class="table-default">
-        <Operate :show="open" />
+        <Operate :show="open">
+          <template #operate>
+            <el-button @click="download('/user')">导出</el-button>
+          </template>
+        </Operate>
         <el-table :data="tableData" class="mt-3" v-loading="loading">
           <el-table-column prop="username" label="用户名" width="150" />
           <el-table-column prop="avatar" label="头像">
@@ -61,6 +65,7 @@ import Department from './components/department.vue'
 import { useUserStore } from '/admin/stores/modules/user'
 import { isUndefined } from '/admin/support/helper'
 import { UserFilled } from '@element-plus/icons-vue'
+import { useExcelDownload } from '/resources/admin/composables/curd/useExcelDownload'
 
 const userStore = useUserStore()
 
@@ -68,6 +73,7 @@ const api = 'users'
 const { data, query, search, reset, loading } = useGetList(api)
 const { destroy, deleted } = useDestroy()
 const { open, close, title, visible, id } = useOpen()
+const { download } = useExcelDownload()
 
 const tableData = computed(() => data.value?.data)
 

resources/admin/composables/curd/useExcelDownload.ts

@@ -0,0 +1,50 @@
+import Request from '/admin/support/request'
+import { ref, watch } from 'vue'
+import Message from '/admin/support/message'
+
+export function useExcelDownload() {
+  const http = new Request()
+  const isSuccess = ref(false)
+  const loading = ref<boolean>(false)
+  const afterDownload = ref()
+  function download(path: string, data: object = {}) {
+    loading.value = true
+    http
+      .setResponseType('blob')
+      .init()
+      .get(path + '/export', data)
+      .then(r => {
+        if (r.headers['content-type'] === 'application/json') {
+          const blob = new Blob([r.data], { type: r.headers['content-type'] })
+          const blobReader = new Response(blob).json()
+          blobReader.then(res => {
+            if (res.code === 1e4) {
+              Message.success(res.message)
+            } else {
+              Message.error(res.message)
+            }
+          })
+        } else {
+          const downloadLink = document.createElement('a')
+          const blob = new Blob([r.data], { type: r.headers['content-type'] })
+          downloadLink.href = URL.createObjectURL(blob)
+          downloadLink.download = r.headers.filename
+          document.body.appendChild(downloadLink)
+          downloadLink.click()
+          document.body.removeChild(downloadLink)
+        }
+      })
+      .finally(() => {
+        loading.value = false
+      })
+  }
+
+  const success = (func: Function) => {
+    watch(isSuccess, function () {
+      isSuccess.value = false
+      func()
+    })
+  }
+
+  return { download, success, loading, afterDownload }
+}

resources/admin/support/http.ts

@@ -1,216 +1,4 @@
-import { Code } from '/admin/enum/app'
-import axios, { AxiosInstance, AxiosRequestConfig } from 'axios'
-import { getAuthToken, getBaseUrl, removeAuthToken } from './helper'
-import Message from './message'
-import router from '/admin/router'
-import ResponseData from '/admin/types/responseData'
+import Request from './request'
 
-/**
- * http util
- */
-class Http {
-  /**
-   * axios config
-   * @protected
-   */
-  protected config: AxiosRequestConfig = {}
-
-  /**
-   * base url
-   * @protected
-   */
-  protected baseURL: string = ''
-
-  /**
-   * http request timeout
-   *
-   * @protected
-   */
-  protected timeout: number = 0
-
-  /**
-   * http request headers
-   *
-   * @protected
-   */
-  protected headers: { [k: string]: string } = {}
-
-  /**
-   * axios instance
-   *
-   * @protected
-   */
-  protected request: AxiosInstance
-
-  /**
-   * instance
-   */
-  constructor() {
-    this.request = axios.create(this.getConfig())
-  }
-
-  /**
-   * get request
-   *
-   * @param path
-   * @param params
-   */
-  public get(path: string, params: object = {}) {
-    return this.request.get(this.baseURL + path, {
-      params,
-    })
-  }
-
-  /**
-   * post request
-   *
-   * @param path
-   * @param data
-   */
-  public post(path: string, data: object = {}) {
-    return this.request.post(this.baseURL + path, data)
-  }
-
-  /**
-   * put request
-   *
-   * @param path
-   * @param data
-   */
-  public put(path: string, data: object = {}) {
-    return this.request.put(this.baseURL + path, data)
-  }
-
-  /**
-   * delete request
-   *
-   * @param path
-   */
-  public delete(path: string) {
-    return this.request.delete(this.baseURL + path)
-  }
-
-  /**
-   * set timeout
-   *
-   * @param timeout
-   * @returns
-   */
-  public setTimeout(timeout: number): Http {
-    this.timeout = timeout
-
-    return this
-  }
-
-  /**
-   * set baseurl
-   *
-   * @param url
-   * @returns
-   */
-  public setBaseUrl(url: string): Http {
-    this.baseURL = url
-
-    return this
-  }
-
-  /**
-   * set headers
-   *
-   * @param key
-   * @param value
-   * @returns
-   */
-  public setHeader(key: string, value: string): Http {
-    this.headers.key = value
-
-    return this
-  }
-
-  /**
-   * get axios 配置
-   *
-   * @returns
-   */
-  protected getConfig(): AxiosRequestConfig {
-    // set base url
-    this.config.baseURL = getBaseUrl()
-
-    // set timeout
-    this.config.timeout = this.timeout ? this.timeout : 10000
-
-    // set ajax request
-    this.headers['X-Requested-With'] = 'XMLHttpRequest'
-    // set dashboard request
-    this.headers['Request-from'] = 'Dashboard'
-    this.config.headers = this.headers
-
-    return this.config
-  }
-
-  /**
-   * 添加请求拦截器
-   *
-   */
-  public interceptorsOfRequest(): void {
-    // @ts-ignore
-    this.request.interceptors.request.use((config: AxiosRequestConfig) => {
-      const token = getAuthToken()
-      if (token) {
-        if (!config.headers) {
-          config.headers = {}
-        }
-
-        config.headers.authorization = 'Bearer ' + token
-      }
-
-      return config
-    })
-  }
-
-  /**
-   * 添加响应拦截器
-   *
-   */
-  public interceptorsOfResponse(): void {
-    this.request.interceptors.response.use(
-      response => {
-        const r: ResponseData = response.data
-        const code = r.code
-        const message = r.message
-        if (code === 1e4) {
-          return response
-        }
-
-        if (code === 10004) {
-          Message.error(message || 'Error')
-        } else if (code === Code.LOST_LOGIN || code === Code.LOGIN_EXPIRED) {
-          // to re-login
-          Message.confirm(message + '，需要重新登陆', function () {
-            removeAuthToken()
-            router.push('/login')
-          })
-        } else if (code === Code.LOGIN_BLACKLIST || code === Code.USER_FORBIDDEN) {
-          Message.error(message || 'Error')
-          removeAuthToken()
-          // to login page
-          router.push('/login')
-        } else {
-          Message.error(message || 'Error')
-        }
-
-        return Promise.reject(new Error(message || 'Error'))
-      },
-      error => {
-        Message.error(error.message)
-        return Promise.reject(error)
-      },
-    )
-  }
-}
-
-const http = new Http()
-http.interceptorsOfRequest()
-
-http.interceptorsOfResponse()
+const http = new Request()
 export default http

resources/admin/support/request.ts

@@ -0,0 +1,235 @@
+import { Code } from '/admin/enum/app'
+import axios, { AxiosInstance, AxiosRequestConfig } from 'axios'
+import { getAuthToken, getBaseUrl, removeAuthToken } from './helper'
+import Message from './message'
+import router from '/admin/router'
+import ResponseData from '/admin/types/responseData'
+
+type responseType = 'arraybuffer' | 'document' | 'json' | 'text' | 'stream' | 'blob'
+
+/**
+ * http util
+ */
+class Request {
+  /**
+   * axios config
+   * @protected
+   */
+  protected config: AxiosRequestConfig = {}
+
+  /**
+   * base url
+   * @protected
+   */
+  protected baseURL: string = ''
+
+  /**
+   * http request timeout
+   *
+   * @protected
+   */
+  protected timeout: number = 0
+
+  /**
+   * http request headers
+   *
+   * @protected
+   */
+  protected headers: { [k: string]: string } = {}
+
+  /**
+   * axios instance
+   *
+   * @protected
+   */
+  // @ts-ignore
+  protected request: AxiosInstance
+
+  /**
+   * 响应结构
+   *
+   * @protected
+   */
+  protected responseType: responseType = 'json'
+
+  public init() {
+    this.request = axios.create(this.getConfig())
+    this.interceptorsOfRequest()
+    this.interceptorsOfResponse()
+    return this
+  }
+
+  /**
+   * get request
+   *
+   * @param path
+   * @param params
+   */
+  public get(path: string, params: object = {}) {
+    this.init()
+    return this.request.get(this.baseURL + path, {
+      params,
+    })
+  }
+
+  /**
+   * post request
+   *
+   * @param path
+   * @param data
+   */
+  public post(path: string, data: object = {}) {
+    this.init()
+    return this.request.post(this.baseURL + path, data)
+  }
+
+  /**
+   * put request
+   *
+   * @param path
+   * @param data
+   */
+  public put(path: string, data: object = {}) {
+    this.init()
+    return this.request.put(this.baseURL + path, data)
+  }
+
+  /**
+   * delete request
+   *
+   * @param path
+   */
+  public delete(path: string) {
+    this.init()
+    return this.request.delete(this.baseURL + path)
+  }
+
+  /**
+   * set timeout
+   *
+   * @param timeout
+   * @returns
+   */
+  public setTimeout(timeout: number): Request {
+    this.timeout = timeout
+
+    return this
+  }
+
+  /**
+   * set baseurl
+   *
+   * @param url
+   * @returns
+   */
+  public setBaseUrl(url: string): Request {
+    this.baseURL = url
+
+    return this
+  }
+
+  /**
+   * set headers
+   *
+   * @param key
+   * @param value
+   * @returns
+   */
+  public setHeader(key: string, value: string): Request {
+    this.headers.key = value
+
+    return this
+  }
+
+  /**
+   * get axios 配置
+   *
+   * @returns
+   */
+  protected getConfig(): AxiosRequestConfig {
+    // set base url
+    this.config.baseURL = getBaseUrl()
+    //
+    this.config.responseType = this.responseType
+    // set timeout
+    this.config.timeout = this.timeout ? this.timeout : 10000
+
+    // set ajax request
+    this.headers['X-Requested-With'] = 'XMLHttpRequest'
+    // set dashboard request
+    this.headers['Request-from'] = 'Dashboard'
+    this.config.headers = this.headers
+    return this.config
+  }
+
+  public setResponseType(type: responseType) {
+    this.responseType = type
+
+    return this
+  }
+
+  /**
+   * 添加请求拦截器
+   *
+   */
+  public interceptorsOfRequest(): void {
+    // @ts-ignore
+    this.request.interceptors.request.use((config: AxiosRequestConfig) => {
+      const token = getAuthToken()
+      if (token) {
+        if (!config.headers) {
+          config.headers = {}
+        }
+
+        config.headers.authorization = 'Bearer ' + token
+      }
+
+      return config
+    })
+  }
+
+  /**
+   * 添加响应拦截器
+   *
+   */
+  public interceptorsOfResponse(): void {
+    this.request.interceptors.response.use(
+      response => {
+        // 如果是 blob response type, 直接返回 response
+        if (response.request.responseType === 'blob') {
+          return response
+        }
+
+        const r: ResponseData = response.data
+        const code = r.code
+        const message = r.message
+        if (code === 1e4) {
+          return response
+        }
+
+        if (code === 10004) {
+          Message.error(message || 'Error')
+        } else if (code === Code.LOST_LOGIN || code === Code.LOGIN_EXPIRED) {
+          // to re-login
+          Message.confirm(message + '，需要重新登陆', function () {
+            removeAuthToken()
+            router.push('/login')
+          })
+        } else if (code === Code.LOGIN_BLACKLIST || code === Code.USER_FORBIDDEN) {
+          Message.error(message || 'Error')
+          removeAuthToken()
+          // to login page
+          router.push('/login')
+        } else {
+          Message.error(message || 'Error')
+        }
+        return Promise.reject(new Error(message || 'Error'))
+      },
+      error => {
+        Message.error(error.message)
+        return Promise.reject(error)
+      },
+    )
+  }
+}
+export default Request