vue3项目目录结构示例详解

更新时间：2023年02月03日 09:49:33 作者：仙说

更好的了解项目的目录结构,能更好的去开发项目,下面这篇文章主要给大家介绍了关于vue3项目目录结构的相关资料,文中通过实例代码介绍的非常详细,需要的朋友可以参考下

一、vue3项目的目录结构详解

node_modules：通过 npm install 下载安装的项目依赖包
public：存放静态资源公共资源，不会被压缩合并
- —3DModel：存放.glb3D模型
- —favicon.ico：网站图标
- —index.html：首页入口.html文件
src：项目开发主要文件夹
- —api
- —assets：静态文件，存放图片
- —components：存放组件
- —store：与vuex相关
- —styles：存放样式
- —utils
- —views：界面组件
- —App.vue：根组件
- —main.js：入口文件
- —router.js：存放路由，实现界面跳转
.gitignore：用来配置那些文件不归git管理
package.json：项目配置和包管理文件（项目依赖和技术）
README.md：说明文档，主要看项目运行的命令
vue.config.js：项目配置信息：跨域proxy代理

二、部分主要文件详解

1、index.html

<%= BASE_URL %>

<%= htmlWebpackPlugin.options.title %>

将vue实例挂载到id为#app的dom上

<!DOCTYPE html>
<html lang="">
<head>
  <meta charset="utf-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width,initial-scale=1.0">
  <link rel="icon" href="<%= BASE_URL %>favicon.ico" rel="external nofollow" >
  <link rel="stylesheet" href="//at.alicdn.com/t/font_3273220_qxa4nju4npj.css" rel="external nofollow" >
  <title>
    <%= htmlWebpackPlugin.options.title %>
  </title>
</head>

<body>
  <noscript>
    <strong>We're sorry but <%= htmlWebpackPlugin.options.title %> doesn't work properly without JavaScript enabled.
        Please enable it to continue.</strong>
  </noscript>
  <!-- 将vue实例挂载到id为#app的dom上 -->
  <div id="app"></div>
  <!-- built files will be auto injected -->
  <style>
   	/* 公共样式可以写在这里 */
  </style>
</body>
</html>

2、main.js（main.ts）

导入组件、路由等

vue3使用createApp这个api返回一个应用实例，并且可以链式调用；这也是与vue2.0不同之处，vue2.0是通过new Vue() 来创建一个vue实例的

createApp(App).use(store).use(router).mount(‘#app’);

import {
  createApp
} from 'vue'
import App from './App.vue'
import router from './router'
import store from './store/index'
import * as Api from './api/index.js'
import ElementPlus from 'element-plus'
import 'element-plus/dist/index.css'
import 'dayjs/locale/zh-cn' //中文
import locale from 'element-plus/lib/locale/lang/zh-cn' //中文
import * as ElIcons from '@element-plus/icons-vue'
import permission from '@/constants/permission';
import UUID from 'vue-uuid';
import "vis/dist/vis.css";

var cesium = require('cesium/Cesium.js');
var widgets = require('cesium//Widgets/widgets.css');

// 创建实例
const app = createApp(App);

// 全局变量、属性
app.config.globalProperties.$api = Api
app.config.globalProperties.Cesium = cesium
app.config.globalProperties.Widgets = widgets

// 添加widow对象
window.Cesium = cesium;

// 统一注册Icon图标
for (const iconName in ElIcons) {
  app.component(iconName, ElIcons[iconName])
}

// 自定义指令实现权限控制
app.directive("permission", permission)

// app.use() 注册全局组件
app.use(ElementPlus, {
  locale
});
app.use(store);
app.use(router);
app.use(UUID);

// 应用实例挂载到#app中，一定要放在最后面
app.mount('#app');

3. package.json

a. scripts

可以使用npm run serve或yarn serve查看项目效果，就是因为有package.json中的scripts起到了作用。

能使用vue-cli-service是因为vue-cli自动安装了cli-service这个工具

serve : 在开发时用于查看效果的命令，视频中演示看一下效果
build : 打包打码，一般用于生产环境中使用
lint : 检查代码中的编写规范
b. dependencies 生产环境 devDependencies 开发环境

这两个都是用来记录安装包信息的，

生产环境：就是代码已经上线，放到了正式的服务器上，公司开始运营去赚钱的代码。

开发环境：作为一个程序员，每天作的事情都是在开发环境中，编写代码、测试代码、修改 Bug。也就说这些代码没有上线。

dependencies下的包是生产环境中必须用到的，当然开发环境也需要。devDependencies是只有开发环境中使用的，上线后这些包就没用了，打包后也不会打包进去的代码。

  "name": "simulator",
  "version": "0.1.0",
  "private": true,
  "scripts": {
    "serve": "vue-cli-service serve",
    "build": "vue-cli-service build",
    "lint": "vue-cli-service lint"
  },
  "dependencies": {
    "@element-plus/icons-vue": "^1.1.4",
    "axios": "^0.26.1",
    "cesium": "*",
    "core-js": "^3.8.3",
    "element-plus": "^2.1.2",
    "file-loader": "^6.2.0",
    "js-md5": "^0.7.3",
    "node-sass": "^7.0.1",
    "nprogress": "^0.2.0",
    "pdfjs-dist": "^2.4.456",
    "sass-loader": "^12.6.0",
    "url-loader": "^4.1.1",
    "vis": "^4.21.0-EOL",
    "vue": "^3.2.13",
    "vue-pdf": "^4.3.0",
    "vue-router": "^4.0.14",
    "vue-uuid": "^3.0.0",
    "vue3-pdf": "^4.2.6",
    "vuedraggable": "^4.1.0",
    "vuex": "^4.0.2"
  },
  "devDependencies": {
    "@babel/core": "^7.12.16",
    "@babel/eslint-parser": "^7.12.16",
    "@babel/plugin-proposal-nullish-coalescing-operator": "^7.16.7",
    "@babel/plugin-proposal-optional-chaining": "^7.16.7",
    "@babel/plugin-proposal-private-methods": "^7.16.11",
    "@types/pdfjs-dist": "^2.10.378",
    "@vue/cli-plugin-babel": "~5.0.0",
    "@vue/cli-plugin-eslint": "~5.0.0",
    "@vue/cli-service": "~5.0.0",
    "copy-webpack-plugin": "^5.1.2",
    "eslint": "^7.32.0",
    "eslint-plugin-vue": "^8.0.3"
  },
  "eslintConfig": {
    "root": true,
    "env": {
      "node": true
    },
    "extends": [
      "plugin:vue/vue3-essential",
      "eslint:recommended"
    ],
    "parserOptions": {
      "parser": "@babel/eslint-parser"
    },
    "rules": {
      "vue/multi-word-component-names": "off",
      "no-unused-vars": "off",
      "no-undef": "off"
    }
  },
  "browserslist": [
    "> 1%",
    "last 2 versions",
    "not dead",
    "not ie 11"
  ]
}

三、其他说明

1. node版本错误

注意，不同的node版本，安装依赖包可能会报错

在vue3项目中，我使用的node版本是 v14.15.1

推荐nvm对不同的node版本进行管理

nvm :node版本管理器

2. 如何调用全局属性

如果在其他.vue文件中你使用的是<script setup>,你会发现直接使用this.$api会报错，

这里提供一个新的api：getCurrentInstance 获取vue当前实例，挂载在全局上的东西都需要通过实例去拿

未亲测过，感兴趣的可以亲测过告诉我可行性~

import { getCurrentInstance } from "vue";
// 拿到实例
const _this = getCurrentInstance ();
// 在实例中有个ctx上下文
_this.ctx.$api

我直接用的是<script>即vue2.0写法编写js代码，则可以直接使用this.$api

3. vue文件中应用vue3.0的api

vue3.0中用setup去包含了所有的钩子等，所有使用的钩子都需要提前导入

总结

到此这篇关于vue3项目目录结构的文章就介绍到这了,更多相关vue3项目目录结构内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Vue3中的element-plus表格实现代码
这篇文章主要介绍了Vue3中的element-plus表格实现代码,用组件属性实现跳转路由,本文通过实例代码给大家介绍的非常详细,需要的朋友可以参考下
2024-05-05
vuecli3.0脚手架搭建及不同的打包环境配置vue.config.js的详细过程
这篇文章主要介绍了vuecli3.0脚手架搭建及不同的打包环境配置vue.config.js的详细过程,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2023-01-01
Vue项目中使用fontawesome图标库的方法
fontawesome的图标有免费版和专业版,本文主要使用free版本,一般free版本的图标够用,free图标又划分为三个图标库,主要有实心图标solid、常规图标regular及品牌图标brand,根据需求去下载对应的图标库,无须全部下载,对vue fontawesome图标库相关知识感兴趣的朋友一起看看吧
2023-12-12
ElementUi中select框在页面滚动时el-option超出元素区域的问题解决
本文主要介绍了ElementUi中select框在页面滚动时el-option超出元素区域的问题解决,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
2024-08-08
带你一文了解Vue生命周期钩子
生命周期钩子又被叫做生命周期时间,生命周期函数,生命周期钩子就是vue生命周期中出发的各类事件,这些事件被称为生命周期钩子,下面这篇文章主要给大家介绍了关于Vue生命周期钩子的相关资料,需要的朋友可以参考下
2022-06-06
vue之bus总线简单使用讲解
这篇文章主要介绍了vue之bus总线简单使用讲解,本篇文章通过简要的案例,讲解了该项技术的了解与使用,以下就是详细内容,需要的朋友可以参考下
2021-09-09
vue-cli解决IE浏览器sockjs-client错误方法
这篇文章主要为大家介绍了vue-cli解决IE浏览器sockjs-client错误方法详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
2023-08-08
vue 导入js中的两种方法(示例详解)
这篇文章主要介绍了vue 导入js中的方法,本文通过两种方法结合示例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2023-07-07
vue 自定义提示框(Toast)组件的实现代码
这篇文章主要介绍了vue 自定义提示框(Toast)组件的实现代码，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2018-08-08
利用vue实现密码输入框/验证码输入框
这篇文章主要为大家详细介绍了如何利用vue实现密码输入框或验证码输入框的效果,文中的示例代码讲解详细,感兴趣的小伙伴可以参考一下
2023-08-08