Laravel 网站项目目录结构规划

Posted 2020-10-03 prop_jeff

最近在用Laravel这个php框架搭网站，大致了解这个框架的目录结构之后感觉学到了不少东西。

---

 

首先安装好包管理器：

PHP部分当然用composer，安装在全局目录下方便一点。

前端部分，我没有选择npm而是使用更“先进”的yarn。

---

 

可以打开 Laravel的官方文档 以供参考。

 

我写这文章是为了理清楚自己的开发思路，以前我直接把整个网站项目从服务器复制到自己的电脑上进行编写，但是这样需要复制的东西实在太多了，大部分是我根本就不会去动第三方的库。所以我得搞清楚如何做能够只需要下载最少的文件，就能够保持我电脑与服务器的文件的同步。这样也方便在本地开服务器进行代码测试，而不用每次都得同步本地修改到服务器，再从服务器测试代码运行结果。

大致的思路就是，只同步包管理器的配置文件，再在本地通过包管理器读取这些配置文件下载与服务器相同的第三方库。

 

1. PHP的依赖

安装好Larvel之后，根目录下会有composer用于存放第三方库的文件夹 vendor，这个文件夹里的东西全部可以加进.gitignore，事实上Laravel默认gitignore 也是这么做的。我们只需要在git加上composer.json就可以同步PHP所使用的库了。

这样从git pull下来的repo，只需要执行composer install就能获得与服务器上相同的库。

2. 前端项目的依赖

前端的库都会放在 Laravel 根目录下 node_modules 目录（以下简称nm）里，这个nm应该放在gitignore里，不同步到git，仅同步packages.json 及 yarn.lock（如果用yarn来替代npm的话）。

本地的repo里，只需要yarn install便能获得与服务器上相同的库。

3. 前端资源的存放

Laravel还有两个文件夹public及resources，本来我一直都是把css js以及其他资源文件比如图片直接放在public文件夹里的，但是似乎这么做是不妥的，特别是使用scss／sass以及Typescript这种需要编译才能生成实际浏览器使用的css／js的文件。

一种比较合理的做法是，将scss以及typescript放在resources里，转译出的最终文件放在public下。这样浏览器可以访问最终css／js文件，但是访问不到源文件。如果转译再minify的话这样做也很方便。总之就是将源文件剥离出public目录，防止用户访问。

转译之类的操作可以使用webpack，同时还可以实现更多高级特性比如模块化。