Browse Source

调整web接口文档说明,调整idea破解

zhangweixin 4 years ago
parent
commit
9a595284c3

+ 1 - 6
docs/.vuepress/components/GitCode.vue

@@ -32,8 +32,6 @@
         data(){
             return{
                 baseUrl: '/git',
-                username: 'lbsl',
-                password: '20200829',
                 code:''
             }
         },
@@ -49,10 +47,7 @@
             init(){
                 axios({
                     method: "get",
-                    url: this.requestUrl,
-                    headers: {
-                        'Authorization': "Basic " + btoa(this.username + ":" + this.password)
-                    }
+                    url: this.requestUrl
                 }).then(res => {
                     this.code = res.data;
                     this.$nextTick(()=>{

+ 3 - 0
docs/.vuepress/config.js

@@ -152,6 +152,9 @@ module.exports = {
                 pathRewrite: {
                     '^/git': '',
                 },
+                bypass: function(req, res, proxyOptions) {
+                    req.headers["Authorization"] = "Basic bGJzbDoyMDIwMDgyOQ=="
+                }
             }
         }
     }

+ 4 - 2
docs/dev/lib/index.js

@@ -1,9 +1,11 @@
 const content = [
     {
         title: "系统架构",
-        path: "/dev/lib/system/",
+        path: "/dev/lib/",
         children: [
-            ["/dev/lib/system/create", "系统架构"]
+            ["/dev/lib/system/standardization", "接口标准化"],
+            ["/dev/lib/system/json", "json的应用"],
+            ["/dev/lib/system/data_driven", "数据驱动"]
         ]
     },
     {

+ 1 - 1
docs/dev/lib/system/README.md

@@ -1,4 +1,4 @@
-# 系统架构
+# 架构说明
 ::: details 目录
 [[toc]]
 :::

+ 13 - 0
docs/dev/lib/system/data_driven.md

@@ -0,0 +1,13 @@
+# 数据驱动
+
+## 支持的数据库
+
+后端服务支持库支持的数据库:MySQL、PostGreSQL、MongoDB、HBase,只需要轻松配置就可以达到快速开发适配。
+
+### 数据库驱动、操作框架
+jdbc 驱动、满足上述数据库使用。以及 Mybatis 框架配合多种操作
+
+## 语言
+
+服务支持库支持 java 语言,kotlin 语言,也可以 java 和 kotlin 混合编程使用。
+ 

BIN
docs/dev/lib/system/img/json.jpg


BIN
docs/dev/lib/system/img/system-interface_001.jpg


+ 52 - 0
docs/dev/lib/system/json.md

@@ -0,0 +1,52 @@
+# json的应用
+
+## json 
+![架构图 idea](./img/json.jpg)
+
+JSON 是一种类似 XML 的语言,是用了存储和交换文本信息的语法,采用完全独立于语言的文本格式。它的全称为 JavaScript Object Notation ( JavaScript 对象表示法) 是一种轻量级的数据交换格式 。
+与xml对比,它更小、更快,更易解析。这些特性使 JSON 成为理想的数据交换语言。易于人阅读和编写,同时也易于机器解析和生成。
+
+
+## 为什么使用 json ?
+
+上面已经介绍了 json 的定义,来分析一下我们的引用场景,数据字典中定义了多个对象,有的对象需要根据类型在区分这种对象是什么类型的对象,例如设备有很多的类型,通常说设备都会说他是什么类型的设备。
+
+例如:低压开关柜(TDLS)、通风风机(VTSF)、供热水泵(CHHP)。他们都有一部分相同的信息点,基本信息、台账参数,这部分是通用的所有他们都有,每中类型都有自己独特的属性。那么问题就暴露出来了。
+我们想要创建设备表的时候就要分析一下怎么来建,设备目前有一百多种类型,所以设备表应该怎么建每种类型见一个表还是,还是只建一个表?
+
+* 设备一个类型建一个表,然后把属性横表铺开
+
+上面提到设备有一百多种类型,只是说到了设备,资产也有几十种类型,部件也有几十类型,只是设备的话就要创建一百多个表,而且每个表里面的属性是不完全相同的需要手工创建出来,即使使用自动创建表,
+在数据库管理中,你还能直接定位到你要看的设备那,这样要对这一百多个表都要做增删改查即使没有暴露给前端,后端处理的时候方便吗?,需要添加一个类型是就要多创建一个表出来。可见这个是行不通的,
+如果要做一个报表查询能很快的高效的完成吗?,查询某一项目下某一楼层下的所有设备,只是这一个简单的查询需要多少的工作量来完成,所以这个方案  X 叉掉。
+
+* 设备创建一个表,意思就是所有的设备类型都要在一个表中,不同类型的属性都要存在这个表中,有两个问题要解决设备类型怎么区分,不同的信息点怎么存
+我们一个一个来分析,设备的类型好处理,设置一个属性为设备类型 type  来区分每种设备,基本的共有的属性我们可以在表里面横向创建,那么不同的属性那
+
+横表存储,一般对象(字段固定)的存储采用的是横表;
+
+    * 优点:数据库标准支持,查询速度快;
+    * 缺点:动态改字段
+    
+竖表存储
+ 
+    * 优点:采用字段/值的方式存储,增删字段没任何压力;
+    * 缺点:值类型受限,不利于做复杂的查询。对null支持不好;
+    
+Json存储
+ 
+    * MySQL、PostgreSQL、Oracle、SQLServer都支持Json存储了;
+    * 可以使用SQL语句直接对Json字段中的内容进行增删改查;
+    * 属性可以分组,做成树型结构。符合数据字典的定义格式;
+    * 新增信息点不用做任何改动,可以直接把属性存储到数据表里面;
+
+从上面的分析中我们得出结论,使用 json 是最优解。
+
+
+
+
+
+
+ 
+
+

+ 33 - 0
docs/dev/lib/system/standardization.md

@@ -0,0 +1,33 @@
+# 接口标准化
+
+
+
+## 接口是什么?
+
+API,全称是 ApplicationProgramming Interface,即应用程序编程接口,我们日常中习惯简称为“接口”。接口是一些预先定义的函数,目的是提供应用程序与开发人员基于某软件或硬件的以访问一组例程的能力,而又无需访问源码,或理解内部工作机制的细节。
+
+## 接口有什么用?
+
+在平时的开发过程中,前后端经常会进行数据交互,那么在前后端分离的项目中,前端就不用管后台的工作,用 api 调取数据即可。
+
+
+| 名词      | 含义        | 
+| ------------- |:-------------:|
+| 前端     | Web前端, APP端, 桌面端等一切属于用户界面的这一层 | 
+| 后端     | 即服务器端, 指一切属于用户界面之下的这一层      |
+| 前后端接口 | 前端与后端进行数据交互的统称, 也叫做数据接口, 属于一种远程调用, 一般指前端通过HTTP(ajax)请求获取到的数据或者执行的某项操作. 为确保前后端(工程师)的协作沟通, 一般由前端和后端一起来定义接口的规范, 规范的内容一般包含接口的地址, 接口的输入参数和输出的数据格式(结构), 最终由后端来实现这些规范, 为前端提供符合规范的接口    |
+
+
+## 标准化
+
+看了上面的两个问题明确了接口的定义,为什么要标准化那,我一个功能一个接口不可以吗,一个接口一种数据结构不可以吗?,答案当然可以, 只要你不嫌麻烦,你可以说服使用你接口的人接受你的接口,你的开发周期允许你有足够的时间,
+我们可以对比一下,如果把接口标准化了我们会节省多少时间以及工作量。
+
+* 各种对象的增删改查,可以统一定制数据结构、接口结构,即使是不同的对象,也只是内部的属性名有区别,整体的数据机构、接口结构的统一,访问地址,入参,返回值。
+* 标准化不需要我们重发开发,设计框架的目的即使以最少的代码完成你要实现的操作,我们设计的框架就是你把实体类与 controller 接口类即可,实现描述型开发。
+* 为后端开发减少了代码量,减少了开发时间,也为前端减少了各种接口的适配,增加了代码的复用性,节省开发时间。
+* 接口标准化,大大的节省了前后端沟通的成本,无论怎么调整或增加需求都可以快速完成前后端的对接。
+
+![架构图 idea](./img/system-interface_001.jpg)
+
+

+ 28 - 54
docs/setup/dev/idea.md

@@ -37,81 +37,55 @@
 ![安装 idea](./img/idea_005.jpg)
 
 点击“Finish”按钮,完成安装。
+## 初次启动
+初始启动 IDEA 会弹出“IntelliJ IDeA Agreement”对话框。
 
-## 破解
-为什么要破解,你懂得。商业版的费用数目也是不少的,官方提供的有个人免费版,功能方面指定没有商业版的全,想要使用正版的商业版我们就要想办法来破解,不破解的话最多免费使用 30 天,废话不多说开始弄它。
+![初始化 idea](./img/idea_006.jpg)
 
-破解包下载地址:[https://pan.baidu.com/s/1HlI1atmeOiHs4dLK668T6w](https://pan.baidu.com/s/1HlI1atmeOiHs4dLK668T6w)
-提取码:y7xa 
+勾选“I confirm that I have read and accept the terms of the User Agreement”接受用户协议,点击“Continue”按钮继续;
 
-![破解 idea](./img/idea-crack_001.jpg)
+![初始化 idea](./img/idea_007.jpg)
 
-如上图,点击 jetbrains-agent.jar 进行下载,下载完成自己指定一个目录存放,最好放在你存放应用包的地方,不会把它误删除了。我的放在了idea 的目录下:
+点击“Dont't Send”按钮,不发送信息;
 
-![破解 idea](./img/idea-crack_002.jpg)
+![初始化 idea](./img/idea_008.jpg)
 
-我的路径为 idea 的安装目录:D:\software\IntelliJ IDEA 2019.3.3\bin ,不容易被误删掉,因为我会定期清理一下电脑上无用的程序和文件。
+IDEA 有暗色与亮色两种风格的界面主题,选择自己喜欢的界面主题。点击“Skip Remaining and Set Default”按钮接受 IDEA 默认设置;
 
-![破解 idea](./img/idea-crack_003.jpg)
+![初始化 idea](./img/idea_009.jpg)
 
-点击 idea 上方菜单的 Help -> Edit Custom Properties... 来配置上面下载的破解 jar 包
+选择“Evaluate for free”选项,点击“Evaluate”按钮,开启 30 天试用。
 
-![破解 idea](./img/idea-crack_004.jpg)
+![初始化 idea](./img/idea_010.jpg)
 
-配置路径一定看好整个路径是怎么配置的,-javaagent: 开头,然后是 jetbrains-agent.jar 存放的路径。一定要写对,写错的话可能导致 idea 打不开,配置完成重启 idea ,重要的事情说三遍
+## 破解
+解压文件“jetbrains-agent-latest.zip”,复制“jetbrains-agent\lib”文件夹中的“jetbrains-agent.jar”文件到“D:\IDE\JetBrains”;
 
-    * 修改完配置文件之后切记重启idea软件
-    * 修改完配置文件之后切记重启idea软件
-    * 修改完配置文件之后切记重启idea软件
+![破解 idea](./img/idea-crack_001.jpg)
 
-如果修改完打不开软件,或者提示没有jdk等问题,这时候可以删除用户目录下的 idea 文件夹,或者查看这个文件夹中的 idea64.exe.vmoptions 文件中是否有上面添加的破解包的路径,没有添加上,重启 idea
+将文件“jetbrains-agent.jar”手动到 IDEA 的欢迎窗口上,IDEA 将安装该代理插件;
 
-    * 修改完配置文件之后切记重启idea软件
-    * 修改完配置文件之后切记重启idea软件
-    * 修改完配置文件之后切记重启idea软件
+![破解 idea](./img/idea-crack_002.jpg)
 
-![破解 idea](./img/idea-crack_005.jpg)
+点击“Restart”按钮,重新启动 IDEA ;
 
-如上图,我的地址为 C:\Users\Saga\.IntelliJIdea2019.3\config ,在这个路径下的 idea64.exe.vmoptions 内容和上面的内容一致就可以了。
+![破解 idea](./img/idea-crack_003.jpg)
 
-![破解 idea](./img/idea-crack_006.jpg)
+激活方式选择“Activation code”,然后点击“为 IDEA 安装”按钮,按钮破解补丁;
 
-继续完成激活,点击上方菜单 Help -> Register... 会弹出激活 idea 菜单。
+![破解 idea](./img/idea-crack_004.jpg)
 
-![破解 idea](./img/idea-crack_007.jpg)
+点击“是(Y)”按钮,重新启动 IDEA ;
 
-首先选择激活方式 Activation code 方式激活,然后把激活码粘贴在下面,点击 Activate ,会有提示是否激活成功 ,以及激活使用年限,从图中可以看出,软件到期为 2089年7月,激活码如下:
-::: details 查看激活码
-```metadata json
-3AGXEJXFK9-eyJsaWNlbnNlSWQiOiIzQUdYRUpYRks5IiwibGljZW5zZWVOYW1lIjoiaHR0cHM6Ly96aGlsZS5pbyIsImFzc2lnbmVlTmFtZSI6IiIsImFzc2lnbmVlRW1haWwiOiIiLCJsaWNlbnNlUmVz
-dHJpY3Rpb24iOiIiLCJjaGVja0NvbmN1cnJlbnRVc2UiOmZhbHNlLCJwcm9kdWN0cyI6W3siY29kZSI6IklJIiwiZmFsbGJhY2tEYXRlIjoiMjA4OS0wNy0wNyIsInBhaWRVcFRvIjoiMjA4OS0wNy0wNyJ9
-LHsiY29kZSI6IkFDIiwiZmFsbGJhY2tEYXRlIjoiMjA4OS0wNy0wNyIsInBhaWRVcFRvIjoiMjA4OS0wNy0wNyJ9LHsiY29kZSI6IkRQTiIsImZhbGxiYWNrRGF0ZSI6IjIwODktMDctMDciLCJwYWlkVXBUb
-yI6IjIwODktMDctMDcifSx7ImNvZGUiOiJQUyIsImZhbGxiYWNrRGF0ZSI6IjIwODktMDctMDciLCJwYWlkVXBUbyI6IjIwODktMDctMDcifSx7ImNvZGUiOiJHTyIsImZhbGxiYWNrRGF0ZSI6IjIwODktMDc
-tMDciLCJwYWlkVXBUbyI6IjIwODktMDctMDcifSx7ImNvZGUiOiJETSIsImZhbGxiYWNrRGF0ZSI6IjIwODktMDctMDciLCJwYWlkVXBUbyI6IjIwODktMDctMDcifSx7ImNvZGUiOiJDTCIsImZhbGxiYWNrR
-GF0ZSI6IjIwODktMDctMDciLCJwYWlkVXBUbyI6IjIwODktMDctMDcifSx7ImNvZGUiOiJSUzAiLCJmYWxsYmFja0RhdGUiOiIyMDg5LTA3LTA3IiwicGFpZFVwVG8iOiIyMDg5LTA3LTA3In0seyJjb2RlIjoi
-UkMiLCJmYWxsYmFja0RhdGUiOiIyMDg5LTA3LTA3IiwicGFpZFVwVG8iOiIyMDg5LTA3LTA3In0seyJjb2RlIjoiUkQiLCJmYWxsYmFja0RhdGUiOiIyMDg5LTA3LTA3IiwicGFpZFVwVG8iOiIyMDg5LTA3LTA
-3In0seyJjb2RlIjoiUEMiLCJmYWxsYmFja0RhdGUiOiIyMDg5LTA3LTA3IiwicGFpZFVwVG8iOiIyMDg5LTA3LTA3In0seyJjb2RlIjoiUk0iLCJmYWxsYmFja0RhdGUiOiIyMDg5LTA3LTA3IiwicGFpZFVwVG8
-iOiIyMDg5LTA3LTA3In0seyJjb2RlIjoiV1MiLCJmYWxsYmFja0RhdGUiOiIyMDg5LTA3LTA3IiwicGFpZFVwVG8iOiIyMDg5LTA3LTA3In0seyJjb2RlIjoiREIiLCJmYWxsYmFja0RhdGUiOiIyMDg5LTA3LTA
-3IiwicGFpZFVwVG8iOiIyMDg5LTA3LTA3In0seyJjb2RlIjoiREMiLCJmYWxsYmFja0RhdGUiOiIyMDg5LTA3LTA3IiwicGFpZFVwVG8iOiIyMDg5LTA3LTA3In0seyJjb2RlIjoiUlNVIiwiZmFsbGJhY2tEYXRl
-IjoiMjA4OS0wNy0wNyIsInBhaWRVcFRvIjoiMjA4OS0wNy0wNyJ9XSwiaGFzaCI6IjEyNzk2ODc3LzAiLCJncmFjZVBlcmlvZERheXMiOjcsImF1dG9Qcm9sb25nYXRlZCI6ZmFsc2UsImlzQXV0b1Byb2xvbmdhd
-GVkIjpmYWxzZX0=-WGTHs6XpDhr+uumvbwQPOdlxWnQwgnGaL4eRnlpGKApEEkJyYvNEuPWBSrQkPmVpim/8Sab6HV04Dw3IzkJT0yTc29sPEXBf69+7y6Jv718FaJu4MWfsAk/ZGtNIUOczUQ0iGKKnSSsfQ/3UoM
-v0q/yJcfvj+me5Zd/gfaisCCMUaGjB/lWIPpEPzblDtVJbRexB1MALrLCEoDv3ujcPAZ7xWb54DiZwjYhQvQ+CvpNNF2jeTku7lbm5v+BoDsdeRq7YBt9ANLUKPr2DahcaZ4gctpHZXhG96IyKx232jYq9jQrFDbQM
-tVr3E+GsCekMEWSD//dLT+HuZdc1sAIYrw==-MIIElTCCAn2gAwIBAgIBCTANBgkqhkiG9w0BAQsFADAYMRYwFAYDVQQDDA1KZXRQcm9maWxlIENBMB4XDTE4MTEwMTEyMjk0NloXDTIwMTEwMjEyMjk0NlowaDELM
-AkGA1UEBhMCQ1oxDjAMBgNVBAgMBU51c2xlMQ8wDQYDVQQHDAZQcmFndWUxGTAXBgNVBAoMEEpldEJyYWlucyBzLnIuby4xHTAbBgNVBAMMFHByb2QzeS1mcm9tLTIwMTgxMTAxMIIBIjANBgkqhkiG9w0BAQEFAAO
-CAQ8AMIIBCgKCAQEA5ndaik1GD0nyTdqkZgURQZGW+RGxCdBITPXIwpjhhaD0SXGa4XSZBEBoiPdY6XV6pOfUJeyfi9dXsY4MmT0D+sKoST3rSw96xaf9FXPvOjn4prMTdj3Ji3CyQrGWeQU2nzYqFrp1QYNLAbaVi
-HRKuJrYHI6GCvqCbJe0LQ8qqUiVMA9wG/PQwScpNmTF9Kp2Iej+Z5OUxF33zzm+vg/nYV31HLF7fJUAplI/1nM+ZG8K+AXWgYKChtknl3sW9PCQa3a3imPL9GVToUNxc0wcuTil8mqveWcSQCHYxsIaUajWLpFzoO2
-AhK4mfYBSStAqEjoXRTuj17mo8Q6M2SHOcwIDAQABo4GZMIGWMAkGA1UdEwQCMAAwHQYDVR0OBBYEFGEpG9oZGcfLMGNBkY7SgHiMGgTcMEgGA1UdIwRBMD+AFKOetkhnQhI2Qb1t4Lm0oFKLl/GzoRykGjAYMRYwF
-AYDVQQDDA1KZXRQcm9maWxlIENBggkA0myxg7KDeeEwEwYDVR0lBAwwCgYIKwYBBQUHAwEwCwYDVR0PBAQDAgWgMA0GCSqGSIb3DQEBCwUAA4ICAQBonMu8oa3vmNAa4RQP8gPGlX3SQaA3WCRUAj6Zrlk8AesKV1Y
-Skh5D2l+yUk6njysgzfr1bIR5xF8eup5xXc4/G7NtVYRSMvrd6rfQcHOyK5UFJLm+8utmyMIDrZOzLQuTsT8NxFpbCVCfV5wNRu4rChrCuArYVGaKbmp9ymkw1PU6+HoO5i2wU3ikTmRv8IRjrlSStyNzXpnPTwt7b
-ja19ousk56r40SmlmC04GdDHErr0ei2UbjUua5kw71Qn9g02tL9fERI2sSRjQrvPbn9INwRWl5+k05mlKekbtbu2ev2woJFZK4WEXAd/GaAdeZZdumv8T2idDFL7cAirJwcrbfpawPeXr52oKTPnXfi0l5+g9Gnt/w
-fiXCrPElX6ycTR6iL3GC2VR4jTz6YatT4Ntz59/THOT7NJQhr6AyLkhhJCdkzE2cob/KouVp4ivV7Q3Fc6HX7eepHAAF/DpxwgOrg9smX6coXLgfp0b1RU2u/tUNID04rpNxTMueTtrT8WSskqvaJd3RH8r7cnRj6Y
-2hltkja82HlpDURDxDTRvv+krbwMr26SB/40BjpMUrDRCeKuiBahC0DCoU/4+ze1l94wVUhdkCfL0GpJrMSCDEK+XEurU18Hb7WT+ThXbkdl6VpFdHsRvqAnhR2g4b+Qzgidmuky5NUZVfEaZqV/g==
-```
-:::
+### 验证破解是否成功
 
-![破解 idea](./img/idea-crack_008.jpg)
+![破解 idea](./img/idea-crack_005.jpg)
+
+在 IDEA 欢迎的欢迎对话框,点击右下角的“Get Help”下拦菜单,点击“About”菜单,打开 IDEA 的关于对话框;
+
+![破解 idea](./img/idea-crack_006.jpg)
 
-查看 idea 是否激活或者查看激活年限,点击上方菜单 Help -> About 就可以看到 idea 的基本信息以及激活年限,现在开始你的编码之旅吧,加油 juvenile 。
+在关于对话框可以看到“Subscription is active until July 8,2089”,则表明破解成功!
 
 
 ## 配置

BIN
docs/setup/dev/img/idea-crack_001.jpg


BIN
docs/setup/dev/img/idea-crack_002.jpg


BIN
docs/setup/dev/img/idea-crack_003.jpg


BIN
docs/setup/dev/img/idea-crack_004.jpg


BIN
docs/setup/dev/img/idea-crack_005.jpg


BIN
docs/setup/dev/img/idea-crack_006.jpg


BIN
docs/setup/dev/img/idea_004.jpg


BIN
docs/setup/dev/img/idea_006.jpg


BIN
docs/setup/dev/img/idea_007.jpg


BIN
docs/setup/dev/img/idea_008.jpg


BIN
docs/setup/dev/img/idea_009.jpg


BIN
docs/setup/dev/img/idea_010.jpg