User工程业务文档

User工程业务文档

本文档仅供参考,实际请以线上业务为准

User 工程包含了用户的个人信息等;

本文档主要介绍了线上业务对应页面资源(html)及静态资源(js/css)情况,整体架构,以便新来者更快的熟悉 User 工程。

大体结构介绍

User 工程首先分为 pcmobile 两个大部分,对应电脑端和移动端,由于历史遗留问题, html 页面托管在 svn ,内嵌在后台业务中,尚未完全分离,所以新增或修改页面,就需要小伙伴们稍微懂点 ecalips ,从 svn 拉下对应工程进行操作。而静态资源 js/css 已经托管到 git

html

User 工程的 html 放在 ShowJoy-User-View 中,其他工程的页面资源也都遵循此命名规范,通过名称很容易从 svn 找到对应工程。先来看一下这张图,对此工程的结构做一些了解:

image

其中常用的是 wap / web 两个大文件夹,接下来对这两个文件夹进行说明:

web(pc端)

image

  • common 其下 config layout 为常用文件夹
    • config 文件夹包含了 gv_config 配置文件,其中配置了 java velocity 模板语法的变量信息。
    • layout 文件夹包含了页面所需的公共头,公共脚,私有头,私有脚信息。
  • page 其下包含了 user 工程的所有页面,这里着重介绍下 use 这个文件夹

image

  • 不在文件夹里的页面,比如 userDetailj.html 都是直接呈现的,而放在文件夹里的,比如 include 文件夹,都是小模板文件,动态嵌入到上述页面里, include 文件夹里的小模板文件,就是嵌入到 userDetail 里的,根据页面链接的不同,嵌入不同的模板文件。
  • 具体页面对应的链接就不详细提供了,下面会说一下如何通过页面找工程。
wap(移动端)

移动端的整体架构和web端的一样,就不重复描述了。

js/css

现在所有静态资源都已经托管在 git 中,各个工程的静态资源都在 showjoy-assets 项目中,比如 User 业务,在此项目中分别为 User-m (移动端), User-p (电脑端)

这里相对比较容易理解,简要介绍一下。

image

User-m 来说,其中分为 buildsrc 两个主要目录

src

  • pages 目录,其下包含了 user 工程中的每个小工程,即每个页面,一个页面一个文件夹,此文件夹下有该小工程的 js、css、less 文件。
  • mixins 目录,此目录下包括了需要引用的less模板文件
  • components 目录,此目录包括了需要引用的本工程独需的js组件。

    build

此目录是经过压缩后的业务静态代码文件,也就是线上真正引用的静态资源。

如何确认html位置

开发中遇到的小问题是,线上链接的名字与html文件名字不对应,如何快速找到html文件是需要一点小窍门的,我是这么做的,举个例子:当前页面链接为 http://user.showjoy.com/u/info.html ,我通过查看当前页面引用资源的链接,比如引用的css链接为 http://cdn1.showjoy.com/assets/f2e/showjoy-assets/user-p/0.0.10/userinfo/userinfo.min.css ,那么html的名字便为 userinfo.html .

怀朔

继续阅读此作者的更多文章