Openresty(十二)openresty使用lua连接mysql

一    官方项目地址

问题：openresty lua '如何操作' mysql呢？  -->'项目地址的帮助文档'

备注：默认安装OpenResty时已经'自带了'该模块 -->'位置如下'

适用：mysql/mariadb两个版本

二     lua-resty-mysql的API简介

①  new

注意： ":"和"."调用方式的区别

 

②    connect

1）mysql的连接配置

+++++++++++"mysql服务器的位置"+++++++++++

host：主机

port：端口

+++++++++++"认证"+++++++++++

user：用户名

password：密码

+++++++++++"字符集"+++++++++++

charset：默认是'utf-8' -->[可选]

+++++++++++"数据库"+++++++++++

database：要连接的数据库

max_packet_size： mysql服务器端和客户端在'一次传送数据包'的过程当中'最大允许'的数据包大小 -->"可选"

强调：配置信息的'名字固定'

2）代码层面 

说明： 要对'返回值'进行'判断'-->连接'是否'成功

if not ok then  
   	ngx.say("connect to mysql error : ", err, " , errno : ", errno, " , sqlstate : ", sqlstate)  
   return close_db(db)  
end 

③    set_timeout

含义： 客户端与'mysql服务器'建立TCP连接的超时时间,属于"tcp层面"的超时

举例： 假设'正常'与数据建立连接'需要3ms',如果我们'设置1ms',将会'报错'

④    close

作用：可以理解为'释放资源'

⑤  query

1) 对数据库进行crud,"统一"的操作方法 query,'不同于'其他语言 insert update delete select

关注点： 对'err'进行判断,并获取'res'-->操作'数据库'的返回结果

 

⑥  防止sql注入

1）客户端目前还'没有'提供'预编译SQL'支持(即占位符替换位置变量)

2) openresty 需要对'输入参数'进行一层过滤即可 -->'针对传递的参数'

具体：在入参时'使用ngx.quote_sql_str'进行字符串'转义',防止sql注入

建议：生产中配置,这里测试则'不使用'

++++++++++++++"下面是一个样例"++++++++++++++

⑦   执行多条sql语句

场景： 同一个数据库,执行多条'sql'语句-->可能是'多个表'的

 

SELECT 1,2,3...的含义及其在SQL注入中的用法

⑧    返回值

说明： 以'http'为例

重点： cjson.encode(res)  --> 转化为'json'字符串,才能响应

1）为什么浏览器访问,不是页面,而是下载

1) 因为openresty"响应"的时候,没有指定'content_type',或者'content_type'书写有问题

2) 默认按照'text/html'的形式进行渲染,但发现'text/html'无法渲染,浏览器'不知道'怎么处理,就会下载

典型例子： 告诉browser我'返回数据的格式',这样浏览器就能'识别'了

ngx.header.content_type = "application/json;charset=utf8"

涉及：http.server 似乎主要是用 'mimetype库' 来猜 Content-Type

参考博客 

⑨  结果集的格式

位置： 属于'配置信息'的地方

三    lua连接mysql实操

说明：关于'mysql server'的安装,可以参照之前的'几篇'博客

核心：openresty化身为'mysql client',向'mysql client'发送请求

++++++++++++++"最佳实践"++++++++++++++

①    通用处理过程

-- 1) 自定义close函数

local function close_db(db)  
    if not db then  
        return  
    end  
    --  连接池机制：不调用close,选择keepalive 确保性能
    local pool_max_idle_time = 10000 --毫秒  
    local pool_size = 100 --连接池大小  
    local ok, err = db:set_keepalive(pool_max_idle_time, pool_size)  
    if not ok then  
        ngx.say("set keepalive error : ", err)  
    end  
end

-- 2) 引入mysql实例
local mysql = require("resty.mysql")

-- 3) 创建实例
local db, err = mysql:new()
if not db then
    ngx.say("new mysql error : ", err)
    return
end

--4) 设置超时时间
db:set_timeout(10000)

--5) 定义连接属性
local props = {
    host = "127.0.0.1",
    port = 3306,
    database = 'openresty',
    user = 'root',
    password = '******',
    charset = 'utf8'
}

-- 6) 建立连接
local res,err,errno,sqlstate = db:connect(props)
-- 备注：异常判断,异常消息统一处理
if not res then
    ngx.say("connect to mysql error:", err,", errno:", errno,", sqlstate:", sqlstate)
    return close_db(db)
end

-- 7) sql 语句操作 -->过程省略

-- 8) 关闭连接 -->由于使用连接池,不需要每次都使用密码

close_db(db)

数据库连接池 

②    sql语句

-- 强调： sql语句执行之后,为了保证'健壮性',一定要做'判断'

-- 1) 删除表user

local drop_table_sql = "drop table if exists user"
res, err, errno, sqlstate = db:query(drop_table_sql)
if not res then
    ngx.say("drop table error :", err,", errno", errno, ", sqlstate : ",sqlstate)
    return close_db(db)
end

-- 2) 创建表user

local create_table_sql = "create table user(id int primary key auto_increment,username varchar(100))"
res, err, errno, sqlstate = db:query(create_table_sql)
if not res then
    ngx.say("create table error :", err,", errno", errno, ", sqlstate : ",sqlstate)
    return close_db(db)
end

-- 3) 向user表'插入'数据

local insert_table_sql = "insert into user(username) values('jack'),('lucy'),('tom'),('lily')"
res, err, errno, sqlstate = db:query(insert_table_sql)
if not res then
    ngx.say("insert table error :", err,", errno", errno, ", sqlstate : ",sqlstate)
    return close_db(db)
end

res, err, errno, sqlstate = db:query(insert_table_sql)

ngx.say("insert rows :", res.affected_rows,", id", res.insert_id, "<br/>")


-- 4) 更新表user

local update_sql = "update user set username = 'lucy' where id = " .. res.insert_id
res, err, errno, sqlstate = db:query(update_sql)
if not res then
    ngx.say("update table error :", err,", errno", errno, ", sqlstate : ",sqlstate)
    return close_db(db)
end

ngx.say("update rows :",res.affected_rows, "<br/>")

-- 5) 查询表 

local select_sql = "select id,username from user"
res, err, errno, sqlstate = db:query(select_sql)
if not res then
    ngx.say("select table error :", err,", errno", errno, ", sqlstate : ",sqlstate)
    return close_db(db)
end

-- 多条'结果集'的处理
for i, row in ipairs(res) do
    for username,value in pairs(row) do
        ngx.say("select row", i," : ", username, " = ", value, "<br/>")
    end
end

-- 6) "条件查询"user

local ch_param = ngx.req.get_uri_args()["ch"] or ''
-- 核心：一定要'转义',防止'sql注入'
local query_sql = "select id,username from user where username = " .. ngx.quote_sql_str(ch_param)

res, err, errno, sqlstate = db:query(query_sql)
if not res then
   ngx.say("select error : ", err, " , errno : ", errno, " , sqlstate : ", sqlstate)
   return close_db(db)
end

for i,row in ipairs(res) do
    for username,value in pairs(row) do
        ngx.say("select row ",i," : ",username, " = ",value,"<br/>")
    end
end

③    执行sql语句返回的格式

1)  对于'新增/修改/删除'会返回如下'格式的响应'： -->"res"中

{
    insert_id = 0,        ----insert_id是在使用'自增序列'时产生的id
    server_status = 2,
    warning_count = 1,
    affected_rows = 10,   ----affected_rows表示'操作影响'的行数
    message = nil
}

2)  对于'查询'会返回'如下格式'的响应：

{
    { id= 1, ch= "hello"},  -- '逗号分割'
    { id= 2, ch= "hello2"}
}

备注：null将返回'ngx.null'

三    openresty技能图谱