我作为一名活跃的网络开发人员已经大约五年了。早在 2019 年底,当我正式开始进行 Web 开发时,我周围就有一个庞大的 Web 开发工具生态系统,我可以利用这些工具为客户和我拥有的任何个人项目创建网站。
但我发现自己走的是自己动手的路线。不是因为我习惯了痛苦和令人头疼的时刻,而是因为我想从基础知识开始学习 Web 开发,而不是直接跳入框架并从那里构建我的知识。
此外,这是大多数经验丰富的 Web 开发人员的建议。学习 HTML、CSS 和 Vanilla JavaScript,以及除此之外的任何其他内容(某种程度上)都会变得轻而易举。
好了,五年后,不知何故,我最终制作了一个自己的 Web 框架。最初只是一个关于 Web 和 Web API 如何工作的简单学习练习,最终成为一个成熟的项目,其中有无数令人头疼的时刻、失望和顿悟。
隆重推出 Oats~i,这是一个开放式 Web 框架,它也可以带您回到基础知识。 Oats~i 提供了一种结构,允许您使用 HTML、CSS 和 Vanilla JavaScript 创建 Web 应用程序,具有强大的可扩展性、服务器端渲染、基于同意的路由、通过数据管理器、视图管理器和钩子的反应性、片段基于视图系统、视图面板支持额外的布局、弹出窗口和片段顶部的自定义视图,支持“本机”Web 浏览功能,例如参数、查询和目标、分页、代码分割以及 JavaScript 和延迟加载查看捆绑包。
所有这些都是框架本身自带的,作为首选模块捆绑器运行在 Webpack 之上。
Oats~i 不关心你的服务器环境,因为它是一个纯粹基于客户端的系统。服务器上没有运行 JS,因此不需要额外的特殊服务器设置来部署 Oats~i 应用程序。
但是在我们了解详细信息之前,它现在在哪里运行?
这里:https://www.vertesolutions.com
该网站是一家从事生态咨询和生态业务的客户的生产网站。该公司名为 Verte Environmental Solutions,因此如果您发现我引用“Verte 的网站”,那就是我所指的网站。
Oats~i目前没有在其他地方运行。
编辑:源代码也是公开的。 https://github.com/Oats-i/Oats-i
在达到这一点之前,多年来我一直在网站的管理面板(定制的)上开发框架、测试、更新和添加新功能。因此,如果您错过了我将在客户端站点上讨论的一些内容,请确保它们在管理员上运行。
此外,我要介绍的是一个相当充实的框架,有几个功能值得讨论。所以请注意,这将是一篇很长的文章。我已尽力对其进行编辑以使其更短。然而,我已经通过这个介绍触及了这一切的要点。在我们开始深入了解未来的文章之前,本文的其余部分只是表面的粗浅。
所以,这个介绍已经足够了。
让我们更深入地了解 Oats~i,因为我到目前为止已经构建了它,并看看它提供的一些开箱即用的功能以及未来的计划。
通过将 Oats~i 称为开放式 Web 框架,我的意思是 Oats~i 是一个简单但可扩展的框架,其代码可以用简单的 HTML 和 Vanilla JavaScript 编写,当然 CSS 是事实上的样式工具。通过这个简单的设置,您可以添加自己的、第三方或自定义的模板引擎、CSS 库和其他工具,只要 Webpack 允许并且您可以配置它。
Oats~i 通过构建系统工作,该系统生成片段作为 Web 应用程序的“组件”或核心部分。以这些简单的视图为例:
这两个图像都有应用程序的“根视图”,这是用户将始终看到的应用程序的主视图。然后还有其他视图(片段)将在其中动态渲染。
根视图可以包含主导航链接或按钮,以及用户将始终在应用程序上看到的其他视图,并且通常不会更改。
根视图中的其余视图将发生变化,这将基于根据用户的路由从应用程序加载和卸载的片段。片段会经历一个构建过程,该过程主要获取要渲染的视图,将其放置在目标父节点中,然后允许您连接应用程序的其余部分和业务逻辑。
Oats~i 构建过程通常会触发片段中的以下核心方法:
//gets the view for your fragment async initializeView(cb){ } //triggers after the fragment view has been attached to the DOM onUIBind(serverSideRendered){ } //triggers after the fragment has completed building and anytime its rebuilt for the same route async onQueryParamsDataUpdate(changedParams, data, savedState, routeParams, isServerSide){ }
基本上就是这样。
有了这样的骨架结构,你就有了一些灵活性,例如:
您重写的第一个方法(initializeView())可以像这样完成:
async initializeView(cb){ const viewAsString = `<p class="text">My view</p>`; this.onViewInitSuccess(viewAsString, cb); }
我们以 HTML 字符串的形式获取视图,并将其传递给内部方法 (onViewInitSuccess()),该方法还接受传递给原始方法的回调。
调用 onViewInitSuccess() 会触发构建过程以继续后续步骤。
在 JS 中将 HTML 编写为字符串很简单,Oats~i 允许这样做,但它经常会出现问题。然而,Oats~i 不是为 Oats~i 构建新的语法或系统来编写视图,而是允许您插入最适合您的用例的任何模板引擎,将其连接到您的 webpack 配置中,并让它发挥其魔力.
对于Verte的情况,我使用handlebars,结合handlebars-loader以hbs格式编写单独的视图文件,并在我的代码中简单地需要它们。
所以,而不是
const viewAsString = `<p class="text">My view</p>`;
我的观点现提供如下:
const viewAsString = require("./relative/path/to/view.hbs")(myTemplatingData);
例如,如果我想使用 ejs,我只需更新我的 webpack 配置并针对该用例使用正确的导入语法。
Oats~我只关心传递给它的视图是一个 HTML 字符串。
Oats~i 甚至允许您通过网络获取您的观点。这就是为什么在initializeView()方法中存在异步的部分原因。
Oats~i 还希望您在这个阶段可能进行网络调用,要么根据用户类型或其他因素获得完整的视图,要么根据您的视图和业务逻辑获取模板数据。
您在这里所做的事情完全取决于您的业务和技术原因。
**注意:**构建系统不等待构建阶段的 Promise 使用 wait 或 then() 进行解析,而是使用传递给相关方法的回调,这是有充分理由的。当我们在后面的文章中深入探讨 Oats~i 的工作原理时,这一点就会很清楚。
Oats~i 代码采用普通 JavaScript,即网络浏览器可以理解的“本机”语言。但是,在编写业务逻辑时,您可以拥有一些灵活性。
例如,无论出于何种原因,您都可以将 jQuery 移植到您的项目中,并使用它来编写部分逻辑。实际上,我很久以前就这样做了,甚至在 Oats~i 构建到当前状态之前,就为 Verte 网站中的平滑滚动效果编写了大约五行代码。 (长话短说,我懒得去思考 Stack Overflow 之外的事情,哈哈)。
理论上你可以在 TypeScript 环境中使用 Oats~i,但我还没有对此进行测试。我对 TypeScript 的唯一用途是它的类型系统,与 JSDocs 结合使用,在框架内记录类型,这是我不久前记录的一种方法。
您可以在此处阅读有关集成 JSDocs 和 TypeScript 以进行打字的信息,而无需构建过程。
Webpack 是一个功能强大的 Web 开发工具,允许进行大规模复杂的项目配置,为开发团队提供了根据其独特规范构建项目所需的灵活性。
Oats~i 运行在 Webpack 之上,该框架主要依靠 Webpack 的代码分割和延迟加载功能来支持异步片段块和捆绑。
这意味着您的片段可以加载到一个包中,也可以使用 webpack 拆分成多个块,从而优化 Oats~i Web 应用程序的初始加载速度。如果您的应用程序需要,请将其与网络来源的视图配对,并且您可以通过多种方式在 Oats~i 中优化您的应用程序,以确保就加载时间而言提供最佳的用户体验。
也许以 webpack 作为 Oats~i 基础的最大优势是您可以使用的大型配置,允许您根据需要制作应用程序。
That's why you can set up templating engines that suit your view rendering process, configure babel and other loaders/plugins for your app, and simply build something that is fully-specced to your project's specifics.
Oats~i runs a simple base webpack configuration that sets up handlebars-loader, html-loader, css loader, asset loader, and HTMLWebpackPlugin to create your server-side views or templates. Using webpack-merge, you can extend these configurations and architect your web app as you want it.
This makes Oats~i works a lot like a plug-and-play system. It gives you a skeleton, and you can wrap and configure your app around it as you like.
Routing is a default feature in Oats~i. In fact, to run the app, you must provide routing information that the app will use to initialize itself and manage user navigation and fragment rendering.
A simple routing information looks like this:
Const MyRoutingInfos = [ { route: "/my-route", target: myMainFragmentBuilder, nestedChildFragments: [ myNestedChildFragmentBuilder ] } ]
When Oats~i loads from the server, it checks the current url and finds a match for it in the provided routing info. In Verte's case, when you load "/", Oats~i searches for the routing info with that that route as a match and then inflates the fragments in order from "target" to each nested child fragment.
You can also provide a default route that Oats~i will try to start the app from, unless the client had sourced the page from a valid route given in your routing info.
Oats~i also supports the use of params in routes, using the colon syntax commonly used in express.
Therefore, a route defined like /:myParams is valid, and will map for routes such as /user-1, /user-2, /user-3.
Oats~i goes a step farther and parses these params for you.
When setting up your fragment, you have the option of setting up params it should watch out for. The name of the param should be an EXACT match to the name used in your routing info.
When building the fragment, Oats~i will parse the value, note any changes, and pass two arguments to your onQueryParamsDataUpdate() method. These are an object of all watched params that have changed, and the current value of all watched params.
Therefore, if you have a fragment that shows user information, defined under the route /:userID, and the client first navigates to /user-xyz, you'll be able to read the value of userID as user-xyz. If the client routes again and this time the route is /user-abc, you'll immediately know that the value of userID has changed to user-abc and you can respond appropriately.
Queries are also a core part of web browsing and urls. Oats~i also parses queries for you, as long as you tell the fragment to watch them, using their keys.
For instance, if your route /:userID maps to /user-3?promptUpgrade=true, and you specify in your fragment that you want to watch updates for the query with the key "promptUpgrade", these will be parsed and sent to the method onQueryParamsDataUpdate() as well.
However:
You cannot write routes in your routing info using queries. Only params are supported. Oats~i looks for the valid routing info for a given url after truncating any queries and targets. The parsing will be done afterwards.
Verte's website already uses this mechanism when rendering views for blog articles at the blog article page. The route for each article is parameterized and we only respond to a change in the watched param.
This is perhaps a very unique feature from Oats~i. Consent-based routing gives you power over the user experience, allowing you to warn users about navigating away from a crucial page in case there are any pending processes, all controlled in-app.
Instead of using the provided standard browser API that pops up a dialog box, Oats~i uses a mix of History API and state management to detect a pop or navigation, ask the current rendered fragments for consent, halt subsequent navigation attempts, and proceed only if the user grants it permission.
If the user chooses to remain in their current view, Oats~i restores the browser's navigation path to the original state.
Of course, having users click on "ok" every time they want to navigate around your app is a bad idea. So, by default, Oats~i fragments and view panels (more on these later) consent to a navigation attempt by default.
Verte internally uses this to safeguard the admin when curating blog content, in case the current draft has not yet been picked up by the autosave script within its time delta. In case the admin wants to navigate away from the blog editor and there are unsaved drafts, they'll get a warning through a dialog and choose to either continue navigating away or stay on the page and manually save their work.
In Oats~i, the framework will primarily render a route through fragments. However, there's an extra utility called view panels that allows you to render other views that your fragment may need on the fly. These include dialog boxes, hamburger panels, or even loading screens with bespoke information that the user may need.
To spawn a view panel, you have to request for it through the view panels manager. Oats~i self manages views for fragments and view panels, meaning you never have to write logic to bind your primary fragment views to the DOM or remove them once a view panel or its associated fragment is being destroyed due to a change in navigation.
A view panel, spawned by a view panels manager is also automatically wired into the consent-routing process of the fragment, allowing you to extend fragment functionality.
View panels can also watch params and queries.
View panels can be triggered either by route changes or directly via a call to the fragment's view panels manager. For the former, this is where having queries in your route and linking them to a view panel within the fragment can come in handy.
If you have a route "/:post-id" which is currently represented in the browser as "/nice-post?showComments=true", you can use a route-triggered view panel within the fragment to automatically pop a side panel that loads the post comments and allows the user to read through them.
This feature is typically accessible through the onQueryParamsDataUpdate() method. Calling super (in case you've overridden it) will invoke the fragment's view panels manager to attempt to render any route-triggered view panels.
The biggest advantage of this kind of setup is that your view panel's rendering and behavior is now tied to the navigation, making the user experience more natural.
So, given our example, if the user navigated to "/nice-post?showComments=true", read the comments, and pressed back, the route will change back to "/nice-post", the view panels manager will note this change, and automatically trigger the destruction process for the view panel as long as consent has been granted.
Just like fragments, view panels also grant consent by default. Therefore, you should override the consent method ONLY when necessary.
A modern web framework is not complete without a good touch of reactivity and data management. And here's where perhaps the most crucial difference between Oats~i and other web frameworks comes in.
Oats~i doesn't automatically couple views to a piece of data or state.
Instead, this is left entirely to the developer to do it based on their app or business logic.
As is, you can use Oats~i to build a web app with multiple static pages rendered under fragments and view panels and end it at that. The app will just work. If you want to add data, network calls, and reactivity, the data manager utility covers everything, and only to the scope that you determine, without affecting any surrounding views or data.
Let's look at the data manager and its supporting utilities: the network interface and view managers.
The data manager is an Oats~i utility that allows you to tie data, server-resources, and client views together. The data manager holds an array of models, a model being the core piece or type of data associated with a section of your app and its selected views.
Currently, I've designed it to take a model as an object with arrays nested within, as it's the most common format for passing data around client and server resources (as Json).
Therefore, a simple model can look something like this:
{ my: string, simple: number, obj: { ofArrays: number[], objArrays: { objKey: string }[] } }
The data manager works by scoping its model. This means that every bit of the model can be treated as a unit, creating a set of dot-separated keys that define a specific value or type in your data.
For instance, in the example above, the data manager will break down the model into the following scopes: "MODEL_ROOT | my | simple | obj | obj.ofArrays | obj.objArrays | obj.objArrays.array.objKey "
These scopes represent:
MODEL_ROOT -> { my: string, simple: number, obj: { ofArrays: number[], objArrays: { objKey: string }[] } } my -> string, simple -> number obj -> { ofArrays: number[], objArrays: { objKey: string }[] } obj.ofArrays -> number[] obj.objArrays -> { objKey: string }[] obj.objArrays.array.objKey -> string
You can treat these scopes as dot-separated paths to a distinct piece of data.
With these scopes, the data manager then gives you, the developer, fine-grained control of your data, allowing to assign a network interface or view manager(s) to any of these data.
Let's shallowly dive into what these two are.
In most apps (native or web), the data shown to the user is sourced from an outside resource, a server. Therefore, the internal model often needs an API interface that sits between itself and the external resource.
In Oats~i's case, the network interface will perform the CRUD operation you need in relation to the data held by the data manager and ensure both ends are in sync.
The network interface is defined as an object with three methods:
getReqBody()
This method gets the body of the request and other data such as method, address, headers, etc.
onDataLoadPostProcess()
Because the type of response data and the type of your internal model may vary, the network interface allows you to post-process the response and provide the final data in the data manager's model type.
onDataLoadError()
This method allows you to format the error response in case the network call fails.
API designs are varied, meaning, the addresses or routes used to make CRUD operations for a given piece of data can be different.
For instance, a social media app can have a different API for loading all posts, and each post running unique APIs to repost, like, or report the post.
Assuming such an architecture, using scoping within the data manager allows you to specify unique network interfaces for each scope.
For instance, you can have a network interface for the MODEL_ROOT network call (which will load the posts), "repost" network call, and any other call that can be scoped out of the structure of the model the data manager holds.
This gives you a whole unique way of viewing your data, breaking it down from one large resource with a common end point, to a collection of multiple data units that can be handled independently through the data manager.
A key thing to note here is that you can only have one network interface per scope, creating a single "endpoint" for every scoped piece of data in your model.
Through the network interface, the data manager can now keep data in sync between its model and the server. Now what about displaying it to the user and, more importantly, showing them when it's changing?
That's where the view manager comes in.
View managers respond to mutations or changes happening to data held by the data manager, through a network operation or a direct in-app change.
Oats~i currently supports two types of view managers - a standard view manager and a list view manager.
A standard view manager is ideal for simple views with components that are not duplicated over a list. On the other hand, a list view manager is best for "complex" views with view components duplicated over a list.
Regardless of the type, a view manager will tell you of the following changes within a model or its scoped types:
onMutate()
This method fires when a data type of the scope is changing
onCommit()
This method fires when a mutation of the data type of the scope has been completed, thus committed
onCancel()
This method fires when a mutation of the data type of the scope has been cancelled
onError()
This method fires when a mutation of the data type of the scope has encountered an error, allowing you to retry
There's also the builder set of methods, which allow you to pass in a view (as a HTML string) inflated with your data. These methods also inform you of when the view has been attached or about to be detached, depending on the mutation.
These three methods are:
inflateRoot()
Gets the templated view as a string for the data provided
onViewAttach()
Calls when the view has been attached to the DOM
onViewDetach()
Calls when the view is about to be detached from the DOM
You can see the results of these interactions in the blog pages of Verte's website.
Using the combination of builder methods, root hooks, and component hooks, the data-driven dynamic views of the blog and blog article fragments can show loading animations when we're sourcing data from the network, show error messages in case of a failure, and populate the views once the new data from the network interface has been committed.
A view manager will also have component hooks which allow for even finer grained reactivity, with the elements of each view node.
For instance, using the model:
{ my: string, simple: number, obj: { ofArrays: number[], objArrays: { objKey: string }[] } }
And a view manager of the scope "MODEL_ROOT" (therefore the whole model), we can assume that the main view component showing the data of the MODEL_ROOT scope, has components within it that my show the specific data held in "my", "simple", "obj", or generally the child scopes of MODEL_ROOT.
Therefore, you can set up a component or element of your view to react to changes in these "child" values.
All these hook methods get a viewNode parameter passed to them by the view manager, so you always have a reference of which view node these data changes are associated with and query its components as you need.
However, you should not bother with removing these core view elements once they're no longer needed. The view manager handles that for you.
Oats~i doesn't operate through a virtual DOM. Instead, the fragments, view panels, and view managers directly use the DOM APIs to insert or remove DOM elements.
After inserting your view component into the DOM, the view manager will provide you with its direct reference in the builder, root, and component hooks. Therefore, you can just directly add listeners, change attributes, or simply manipulate the DOM element using the direct DOM apis.
A core bit of a complex web app is lifecycle management. Oats~i has its own lifecycle management process for fragments and view panels, whose functions are extended to other utilities such as the data manager, view managers, and remote request util (the actual utility the data manager uses in conjunction with the network interface to make network calls).
Therefore, straight off the bat, using Oats~i and its core utilities will have lifecycle automatically managed for you.
For instance, if you're using the data manager within a fragment to make a CRUD operation, and the user navigates away from the fragment, the data manager and remote request util will be able to cancel all network operations, skip updating view managers, and unregister them, because your fragment or view panel no longer exists.
As an Oats~i developer, you can make use of a fragment or view panel's lifecycle management to create robust lifecycle-aware libraries that will work well in an Oats~i environment.
You just have to grab the lifecycle object using the internal method,
getLifeCycleObject()
and attach listeners to it. These listeners typically include four methods for:
onFragmentRunning()
Called when the fragment has been created and is running
onFragmentCancelled()
Called when the fragment's build has been cancelled
onFragmentDestroyed()
Called when the fragment has been destroyed
onViewReady()
Called when the fragment's view has been attached to DOM
*Note: *"Fragment" here also applies to view panels.
The main calls you need to watch out for are onFragmentRunning(), onViewReady(), and onFragmentDestroyed(). If your library adds functionality that is not UI-related, you can enable the library after getting the onFragmentRunning() call.
If the library manipulates views (such as an animation library), you can enable its functionality after receiving the onViewReady() call.
Once you get the onFragmentDestroyed() call, pack up, and stop everything.
We have talk about a lot about some core features of Oats~i but we haven't talked about paradigm. How will you write core Oats~i code?
Well, Oats~i is an OOP-based web framework. That means most utilities are provided as classes. A fragment is created from an AppMainFragment or AppChildFragment class. The data manager is a class. View managers are classes and so on.
I chose OOP because of its reusability, garbage collection, and a much cleaner way of managing functions and processes within Oats~i.
For instance, no pun intended, having the fragment as a class allows Oats~i to do something clever. It never reconstructs the fragment class if it determines that its being reused. Instead, the build process just goes directly to firing onQueryParamsDataUpdate(), and doesn't re-render the fragment's main view or update that section of the DOM, since it's unnecessary.
Another advantage of doing this is that your fragment can retain part of its state amidst related route calls.
For instance, in Verte's case, when you're in the fragment that renders a blog article, clicking on another article under the "Other stories" list doesn't reconstruct the fragment. Instead, the original view is untouched, and only the dynamic, data-driven views, ran by the data manager in conjunction with the view manager, update based on the new param value obtained from onQueryParamsDataUpdate().
Just because the Oats~i core uses OOP, doesn't mean you're fully restricted to creating libraries that follow the OOP paradigm. Simply making them lifecycle aware is enough.
This will allow them to capture and free resources from the fragment as Oats~i renders and destroys them.
When porting Verte's client to Oats~i, I've used this exact strategy to reuse some functional scripts I'd written for the original webpages.
Therefore, I expect very few bottlenecks and paradigm strictness for developers seeking to use their functional scripts in an Oats~i project, as long as they're lifecycle aware.
Finally, a big part of modern web frameworks - server-side rendering.
Oats~i natively supports server-side rendering, with no need for running JavaScript on the server.
Using HTMLWebpackPlugin, you can extract the views you use for each fragment in your Oats~i app into their own .html/.hbs files that you can send to the client when they request for a page on a fresh load.
The only requirement is your view structure from the server is the same as the app would have rendered it.
But we're not done yet.
The views you'll render from your server most likely will represent some state of data. How does Oats~i handle this and proceed from the server-side rendered state?
You'll ideally be using the data manager to manage dynamic or data-driven views in your Oats~i app. Now, using it, you can can leverage server-side hydration that uses a script rendered in the head tag from the server to help the data manager understand the data state from the server, save it, and have attached view managers also update their states based on it, and continue running the app from there.
Here's how it works.
In your markup's head, at the server, you can add a script of the following format:
<script id="hydrator_id"> const DataManagerHydrationInfo = { "info_key": { info: model[] extras: * } } window.DataManagerHydrationInfo = DataManagerHydrationInfo; </script>
This script provides important information for the data manager from the server, that gives it the full picture or an idea of the data state.
Each data manager will have an "info_key" that it will read its data state from. Once you set the data manager to hydrate from server side, it will find the script with the id you provide, get the exposed variable DataManagerHydrationInfo, and read the value of "info_key".
This value should be an array, ideally of the same type as the data manager's model. However, it can be different.
That's because the data manager runs a multi-step hydration process.
Reading from a script can have its own issues and vulnerabilities. You can run a validation check on the data stored in the hydration script before the data manager commits it.
Depending on your business logic and web app design, the data format sourced from your server can be different from the model you run in your data manager. Oats~i's data manager runs an optional preprocessing step during hydration, that allows you to convert the data from the hydrator to your model's format.
This step permits you to be cautious with the data you let free in your hydration script, open to web scrapers, robots, and search engines.
You can run an optional network step where you can get private or hidden data that your data manager's model needs, but should never be privy to web scrapers or robots scouring the web.
For instance, if you're hydrating a shopping cart, you can have the hydration script from the server contain only general information about the products, with public ids that when passed to your secure backend, will return more secret information that you'll use to check-out the user.
So, your hydration script can hold information as basic as what is already rendered in the html, have the data manager commit that immediately internally, then source everything else from the network cycle.
If you've managed to read up to this point, kudos, you're a champ! That's the best I could do to try and squeeze roughly four years of work into a small "introductory" blog post.
Oats~i has been a massive learning project for me and am both anxious and excited to let the tech community know about it. There's a lot to unpack, teach, learn, and debug.
My plan at the moment is to open source Oats~i. I'm working on the specifics and hopefully the whole codebase will drop in the next few days and we can all dig in, build actual web apps through the framework, and take it up its paces.
For now, I'll appreciate your feedback, comments, and questions concerning Oats~i, if you have any.
Check out Verte Environmental Solution's website and see it in action.
I'm available on LinkedIn, so drop by and say hi.
See you soon, when we'll, hopefully, start building with Oats~i.
EDIT: The source code is now public. https://github.com/Oats-i/Oats-i
以上是Oats 简介~i - 开放式 Web 框架的详细内容。更多信息请关注PHP中文网其他相关文章!