【前端vue】理解VUE前端框架中src下的api文件夹与views文件夹

⭐前言

在 Vue 项目中，api 和 views 是两个非常重要的目录，它们分别承担不同的职责。以下是理解这两个目录的指南：

⭐一、api 文件夹

🌟用途

存放所有与后端接口交互的代码（HTTP 请求封装）。

集中管理项目的 API 接口，方便维护和复用。

🌟典型结构

🌟代码示例

import request from '@/utils/request'

// 部门列表
export function deptLists(params?: any) {
    return request.get({ url: '/dept.dept/lists', params })
}

// 添加部门
export function deptAdd(params: any) {
    return request.post({ url: '/dept.dept/add', params })
}

// 编辑部门
export function deptEdit(params: any) {
    return request.post({ url: '/dept.dept/edit', params })
}

// 删除部门
export function deptDelete(params: any) {
    return request.post({ url: '/dept.dept/delete', params })
}

// 部门详情
export function deptDetail(params: any) {
    return request.get({ url: '/dept.dept/detail', params })
}

// 部门列表全部
export function deptAll() {
    return request.get({ url: '/dept.dept/all' })
}

🌟如何理解？

• 每个 .api.js 文件对应一个功能模块的接口。

• 接口函数通常使用 axios 或 fetch 发起 HTTP 请求。

• 在 Vue 组件中，会通过 import { login } from ‘@/api/user.api’ 调用这些接口。

⭐二、views 文件夹

🌟用途

• 存放页面级 Vue 组件（路由对应的页面）。

• 通常与路由配置（src/router/index.js）一一对应。

🌟典型结构

🌟代码示例

<template>
    <div class="article-lists">
        <el-card class="!border-none" shadow="never">
            <el-form ref="formRef" class="mb-[-16px]" :model="queryParams" :inline="true">
                <el-form-item label="文章标题">
                    <el-input
                        class="w-[280px]"
                        v-model="queryParams.title"
                        clearable
                        @keyup.enter="resetPage"
                    />
                </el-form-item>
                <el-form-item label="栏目名称">
                    <el-select class="w-[280px]" v-model="queryParams.cid">
                        <el-option label="全部" value />
                        <el-option
                            v-for="item in optionsData.article_cate"
                            :key="item.id"
                            :label="item.name"
                            :value="item.id"
                        />
                    </el-select>
                </el-form-item>
                <el-form-item label="文章状态">
                    <el-select class="w-[280px]" v-model="queryParams.is_show">
                        <el-option label="全部" value />
                        <el-option label="显示" :value="1" />
                        <el-option label="隐藏" :value="0" />
                    </el-select>
                </el-form-item>
                <el-form-item>
                    <el-button type="primary" @click="resetPage">查询</el-button>
                    <el-button @click="resetParams">重置</el-button>
                </el-form-item>
            </el-form>
        </el-card>
        <el-card class="!border-none mt-4" shadow="never">
            <div>
                <router-link
                    v-perms="['article.article/add', 'article.article/add:edit']"
                    :to="{
                        path: getRoutePath('article.article/add:edit')
                    }"
                >
                    <el-button type="primary" class="mb-4">
                        <template #icon>
                            <icon name="el-icon-Plus" />
                        </template>
                        发布文章
                    </el-button>
                </router-link>
            </div>
            <el-table size="large" v-loading="pager.loading" :data="pager.lists">
                <el-table-column label="ID" prop="id" min-width="80" />
                <el-table-column label="封面" min-width="100">
                    <template #default="{ row }">
                        <image-contain
                            v-if="row.image"
                            :src="row.image"
                            :width="60"
                            :height="45"
                            :preview-src-list="[row.image]"
                            preview-teleported
                            fit="contain"
                        />
                    </template>
                </el-table-column>
                <el-table-column
                    label="标题"
                    prop="title"
                    min-width="160"
                    show-tooltip-when-overflow
                />
                <el-table-column label="栏目" prop="cate_name" min-width="100" />
                <el-table-column label="作者" prop="author" min-width="120" />
                <el-table-column label="浏览量" prop="click" min-width="100" />
                <el-table-column label="状态" min-width="100">
                    <template #default="{ row }">
                        <el-switch
                            v-perms="['article.article/updateStatus']"
                            v-model="row.is_show"
                            :active-value="1"
                            :inactive-value="0"
                            @change="changeStatus($event, row.id)"
                        />
                    </template>
                </el-table-column>
                <el-table-column label="排序" prop="sort" min-width="100" />
                <el-table-column label="发布时间" prop="create_time" min-width="120" />
                <el-table-column label="操作" width="120" fixed="right">
                    <template #default="{ row }">
                        <el-button
                            v-perms="['article.article/edit', 'article.article/add:edit']"
                            type="primary"
                            link
                        >
                            <router-link
                                :to="{
                                    path: getRoutePath('article.article/add:edit'),
                                    query: {
                                        id: row.id
                                    }
                                }"
                            >
                                编辑
                            </router-link>
                        </el-button>
                        <el-button
                            v-perms="['article.article/delete']"
                            type="danger"
                            link
                            @click="handleDelete(row.id)"
                        >
                            删除
                        </el-button>
                    </template>
                </el-table-column>
            </el-table>
            <div class="flex justify-end mt-4">
                <pagination v-model="pager" @change="getLists" />
            </div>
        </el-card>
    </div>
</template>
<script lang="ts" setup name="articleLists">
import { articleCateAll, articleDelete, articleLists, articleStatus } from '@/api/article'
import { useDictOptions } from '@/hooks/useDictOptions'
import { usePaging } from '@/hooks/usePaging'
import { getRoutePath } from '@/router'
import feedback from '@/utils/feedback'

const queryParams = reactive({
    title: '',
    cid: '',
    is_show: ''
})

const { pager, getLists, resetPage, resetParams } = usePaging({
    fetchFun: articleLists,
    params: queryParams
})

const { optionsData } = useDictOptions<{
    article_cate: any[]
}>({
    article_cate: {
        api: articleCateAll
    }
})

const changeStatus = async (is_show: any, id: number) => {
    try {
        await articleStatus({ id, is_show })
        getLists()
    } catch (error) {
        getLists()
    }
}

const handleDelete = async (id: number) => {
    await feedback.confirm('确定要删除？')
    await articleDelete({ id })
    getLists()
}

onActivated(() => {
    getLists()
})

getLists()
</script>

🌟如何理解？

• 每个 .vue 文件对应一个页面，通过路由访问（如 /user/login）。

• 页面组件会调用 api 中的接口函数，完成数据交互。

• 可能包含子组件（位于 src/components 目录）的引用。

⭐三、关系关联

• 路由配置（src/router/index.js）定义了哪些视图（views）对应哪些 URL。

• 视图组件（views/*.vue）在需要数据时，调用 api 中的接口函数。

• API 模块（api/*.api.js）将数据返回给视图组件，驱动页面渲染。

典型调用链

路由 → 渲染视图组件 → 调用 API 接口 → 后端返回数据 → 更新页面

⭐四、快速理解代码的技巧

• 从路由入手
  打开 src/router/index.js，找到 URL 路径对应的视图组件（如 /user/login 对应 views/User/Login.vue）。

• 追踪 API 调用
  在视图组件中搜索 import … from '@/api/，找到调用的接口模块。

• 调试工具
  使用浏览器开发者工具的 Network 标签观察 API 请求。
  使用 Vue Devtools 查看组件层级。

• 文档辅助
  如果项目有 Swagger 或接口文档，可结合文档理解 API 功能。

⭐五、常见问题

• 为什么 API 要单独抽离？
  集中管理接口，避免在组件中散落重复代码，方便统一修改（如更换请求库或处理全局错误）。

• 视图组件和普通组件（components 目录）的区别？
  视图组件是路由对应的完整页面，普通组件是复用的 UI 单元（如按钮、表格）。

⭐总结

通过这种分层设计，项目的可维护性和代码清晰度会显著提高。如果遇到具体代码细节问题，可以进一步分析示例文件！