MySQL存储过程与函数

Posted on 2022-04-13 Edited on 2024-07-22 In 数据库 , MySQL Views: Word count in article: 9.5k Reading time ≈ 9 mins.

1、概述

MySQL从5.0版本开始支持存储过程和函数。存储过程和函数能够将复杂的SQL逻辑封装在一起，应用程序无须关注存储过程和函数内部复杂的SQL逻辑，而只需要简单地调用存储过程和函数即可。

存储过程概述

含义：存储过程的英文是Stored Procedure。它的思想很简单，就是一组经过预先编译的SQL语句的封装。
执行过程：存储过程预先存储在MySQL服务器上，需要执行的时候，客户端只需要向服务器端发出调用存储过程的命令，服务器端就可以把预先存储好的这一系列SQL语句全部执行。
好处：
- 简化操作，提高了sql语句的重用性，减少了开发程序员的压力。
- 减少操作过程中的失误，提高效率。
- 减少网络传输量（客户端不需要把所有的 SQL 语句通过网络发给服务器）。
- 减少了SQL语句暴露在网上的风险，也提高了数据查询的安全性。
和视图、函数的对比：
- 它和视图有着同样的优点，清晰、安全，还可以减少网络传输量。不过它和视图不同，视图是虚拟表，通常不对底层数据表直接操作，而存储过程是程序化的SQL，可以直接操作底层数据表，相比于面向集合的操作方式，能够实现一些更复杂的数据处理。
- 一旦存储过程被创建出来，使用它就像使用函数一样简单，我们直接通过调用存储过程名即可。相较于函数，存储过程是没有返回值的。
分类：
- 存储过程的参数类型可以是IN、OUT和INOUT。根据这点分类如下：
  - 没有参数（无参数无返回）
  - 仅仅带IN类型（有参数无返回）
  - 仅仅带OUT类型（无参数有返回）
  - 既带IN又带OUT（有参数有返回）
  - 带INOUT（有参数有返回）
  注意：IN、OUT、INOUT都可以在一个存储过程中带多个。

2、创建存储过程

语法分析

语法：

CREATE PROCEDURE 存储过程名(IN|OUT|INOUT 参数名 参数类型,...)
[characteristics ...]
BEGIN
	存储过程体
END

# 类似于Java中的方法：
修饰符 返回类型 方法名(参数类型 参数名,...){
	方法体;
}

参数前面的符号的意思。
- IN：当前参数为输入参数，也就是表示入参；
  - 存储过程只是读取这个参数的值。如果没有定义参数种类，默认就是IN，表示输入参数。
- OUT：当前参数为输出参数，也就是表示出参；
  - 执行完成之后，调用这个存储过程的客户端或者应用程序就可以读取这个参数返回的值了。
- INOUT：当前参数既可以为输入参数，也可以为输出参数。
形参类型可以是MySQL数据库中的任意类型。
characteristics表示创建存储过程时指定的对存储过程的约束条件，其取值信息如下：
1
2
3
4
5
LANGUAGE SQL
| [NOT] DETERMINISTIC
| { CONTAINS SQL | NO SQL | READS SQL DATA | MODIFIES SQL DATA }
| SQL SECURITY { DEFINER | INVOKER }
| COMMENT 'string'
- LANGUAGE SQL：说明存储过程执行体是由SQL语句组成的，当前系统支持的语言为SQL。
- [NOT] DETERMINISTIC：指明存储过程执行的结果是否确定。DETERMINISTIC表示结果是确定的。每次执行存储过程时，相同的输入会得到相同的输出。NOT DETERMINISTIC表示结果是不确定的，相同的输入可能得到不同的输出。如果没有指定任意一个值，默认为NOT DETERMINISTIC。
- { CONTAINS SQL | NO SQL | READS SQL DATA | MODIFIES SQL DATA }：指明子程序使用SQL语句的限制。
  - CONTAINS SQL表示当前存储过程的子程序包含SQL语句，但是并不包含读写数据的SQL语句；
  - NO SQL表示当前存储过程的子程序中不包含任何SQL语句；
  - READS SQL DATA表示当前存储过程的子程序中包含读数据的SQL语句；
  - MODIFIES SQL DATA表示当前存储过程的子程序中包含写数据的SQL语句。
  - 默认情况下，系统会指定为CONTAINS SQL。
- SQL SECURITY { DEFINER | INVOKER }：执行当前存储过程的权限，即指明哪些用户能够执行当前存储过程。
  - DEFINER表示只有当前存储过程的创建者或者定义者才能执行当前存储过程；
  - INVOKER表示拥有当前存储过程的访问权限的用户能够执行当前存储过程。
  - 如果没有设置相关的值，则MySQL默认指定值为DEFINER。
- COMMENT 'string'：注释信息，可以用来描述存储过程。

存储过程体中可以有多条SQL语句，如果仅仅一条SQL语句，则可以省略BEGIN和END编写存储过程并不是一件简单的事情，可能存储过程中需要复杂的SQL语句。

1. BEGIN…END：BEGIN…END 中间包含了多个语句，每个语句都以（;）号为结束符。
2. DECLARE：DECLARE 用来声明变量，使用的位置在于 BEGIN…END 语句中间，而且需要在其他语句使用之前进
行变量的声明。
3. SET：赋值语句，用于对变量进行赋值。
4. SELECT… INTO：把从数据表中查询的结果存放到变量中，也就是为变量赋值。

需要设置新的结束标记。
1
DELIMITER 新的结束标记
- 因为MySQL默认的语句结束符号为分号‘;’。为了避免与存储过程中SQL语句结束符相冲突，需要使用 DELIMITER改变存储过程的结束符。
- 比如：“DELIMITER //”语句的作用是将MySQL的结束符设置为//，并以“END //”结束存储过程。存储过程定义完毕之后再使用“DELIMITER ;”恢复默认结束符。DELIMITER也可以指定其他符号作为结束符。
- 当使用DELIMITER命令时，应该避免使用反斜杠（‘\’）字符，因为反斜线是MySQL的转义字符。
  1
  2
  3
  4
  5
  6
  7
  DELIMITER $
  CREATE PROCEDURE 存储过程名(IN|OUT|INOUT 参数名参数类型,...)
  [characteristics ...]
  BEGIN
  sql语句1;
  sql语句2;
  END $

创建存储过程

类型1：无参数无返回值。

# 创建存储过程select_all_data()，查看 employees 表的所有数据
DELIMITER $

CREATE PROCEDURE select_all_data()
BEGIN
	SELECT * FROM employees;
END $

DELIMITER ;

# 调用
CALL select_all_data();

# 创建存储过程avg_employee_salary()，返回所有员工的平均工资
DELIMITER //

CREATE PROCEDURE avg_employee_salary()
BEGIN 
	SELECT AVG(salary) FROM employees;
END //

DELIMITER ;

# 调用
CALL avg_employee_salary();

# 创建存储过程show_max_salary()，用来查看“emps”表的最高薪资值。
DELIMITER //

CREATE PROCEDURE show_max_salary()
BEGIN
	SELECT MAX(salary)
	FROM employees;
END //

DELIMITER ;

# 调用
CALL show_max_salary();

类型2：带OUT。

# 创建存储过程show_min_salary()，查看“emps”表的最低薪资值。并将最低薪资
# 通过OUT参数“ms”输出
DELIMITER //

CREATE PROCEDURE show_min_salary(OUT ms DOUBLE)
BEGIN
	SELECT MIN(salary) INTO ms
	FROM employees;
END //

DELIMITER ;

# 调用
CALL show_min_salary(@ms);

# 查看变量值
SELECT @ms;

类型3：带IN。

# 创建存储过程show_someone_salary()，查看“emps”表的某个员工的薪资，并用IN参数empname输入员工姓名。
DELIMITER //

CREATE PROCEDURE show_someone_salary(IN empname VARCHAR(20))
BEGIN
	SELECT salary FROM employees
	WHERE last_name = empname;
END //

DELIMITER ;

# 调用方式1
CALL show_someone_salary('Abel');
# 调用方式2
SET @empname := 'Abel';
CALL show_someone_salary(@empname);

类型4：带IN和OUT。

# 创建存储过程show_someone_salary2()，查看“emps”表的某个员工的薪资，并用IN参数empname输入员工姓名，用OUT参数empsalary输出员工薪资。
DELIMITER //

CREATE PROCEDURE show_someone_salary2(IN empname VARCHAR(20),OUT empsalary DECIMAL(10,2))
BEGIN
	SELECT salary INTO empsalary
	FROM employees
	WHERE last_name = empname;
END //

DELIMITER ;

# 调用
SET @empname = 'Abel';
CALL show_someone_salary2(@empname,@empsalary);
# 查看变量值
SELECT @empsalary;

类型5：带INOUT。

# 创建存储过程show_mgr_name()，查询某个员工领导的姓名，并用INOUT参数“empname”输入员工姓名，输出领导的姓名。
DESC employees;

DELIMITER $

CREATE PROCEDURE show_mgr_name(INOUT empname VARCHAR(25))
BEGIN
	SELECT last_name INTO empname
	FROM employees
	WHERE employee_id = (
				SELECT manager_id
				FROM employees
				WHERE last_name = empname
				);
END $

DELIMITER ;

# 调用
SET @empname := 'Abel';
CALL show_mgr_name(@empname);
# 查看变量值
SELECT @empname;

3、调用存储过程

存储过程有多种调用方法。存储过程必须使用CALL语句调用，并且存储过程和数据库相关，如果要执行其他数据库中的存储过程，需要指定数据库名称，例如CALL dbname.procname。
1
CALL 存储过程名(实参列表)
- 调用in模式的参数：
  1
  CALL sp1('值');
- 调用out模式的参数：
  1
  2
  3
  SET @name;
  CALL sp1(@name);
  SELECT @name;
- 调用inout模式的参数：
  1
  2
  3
  SET @name=值;
  CALL sp1(@name);
  SELECT @name;
调试技巧。
- 在MySQL中，存储过程不像普通的编程语言（比如 VC++、Java 等）那样有专门的集成开发环境。因此，你可以通过SELECT语句，把程序执行的中间结果查询出来，来调试一个SQL语句的正确性。调试成功之后，把SELECT语句后移到下一个SQL语句之后，再调试下一个SQL语句。这样逐步推进，就可以完成对存储过程中所有操作的调试了。当然，你也可以把存储过程中的SQL语句复制出来，逐段单独调试。

4、存储函数的使用

前面学习了很多函数，使用这些函数可以对数据进行的各种处理操作，极大地提高用户对数据库的管理效率。MySQL支持自定义函数，定义好之后，调用方式与调用MySQL预定义的系统函数一样。
语法格式：
1
2
3
4
5
6
CREATE FUNCTION 函数名(参数名参数类型,...)
RETURNS 返回值类型
[characteristics ...]
BEGIN
函数体 #函数体中肯定有 RETURN 语句
END
- 参数列表：指定参数为IN、OUT或INOUT只对PROCEDURE是合法的，FUNCTION中总是默认为IN参数。
- RETURNS type语句表示函数返回数据的类型；
  - RETURNS子句只能对FUNCTION做指定，对函数而言这是强制的。它用来指定函数的返回类型，而且函数体必须包含一个RETURN value语句。
- characteristic创建函数时指定的对函数的约束。取值与创建存储过程时相同，这里不再赘述。
- 函数体也可以用BEGIN…END来表示SQL代码的开始和结束。如果函数体只有一条语句，也可以省略 BEGIN…END。
调用存储函数：
- 在MySQL中，存储函数的使用方法与MySQL内部函数的使用方法是一样的。换言之，用户自己定义的存储函数与MySQL内部函数是一个性质的。区别在于，存储函数是用户自己定义的，而内部函数是MySQL 的开发者定义的。
  1
  SELECT 函数名(实参列表)

例子：

# 创建存储函数，名称为email_by_name()，参数定义为空，该函数查询Abel的email，并返回，数据类型为字符串型。
DELIMITER //

CREATE FUNCTION email_by_name()
RETURNS VARCHAR(25)
	DETERMINISTIC
	CONTAINS SQL
	READS SQL DATA
BEGIN
	RETURN (SELECT email FROM employees WHERE last_name = 'Abel');
END //

DELIMITER ;

# 调用
SELECT email_by_name();

# 创建存储函数，名称为email_by_id()，参数传入emp_id，该函数查询emp_id的email，并返回，数据类型为字符串型。
# 创建函数前执行此语句，保证函数的创建会成功
SET GLOBAL log_bin_trust_function_creators = 1;

DELIMITER //

CREATE FUNCTION email_by_id(emp_id INT)
RETURNS VARCHAR(25)

BEGIN
	RETURN (SELECT email FROM employees WHERE employee_id = emp_id);

END //

DELIMITER ;

# 调用方式1
SELECT email_by_id(101);
# 调用方式2
SET @emp_id := 102;
SELECT email_by_id(@emp_id);

# 创建存储函数count_by_id()，参数传入dept_id，该函数查询dept_id部门的员工人数，并返回，数据类型为整型。
DELIMITER //

CREATE FUNCTION count_by_id(dept_id INT)
RETURNS INT

BEGIN
	RETURN (SELECT COUNT(*) FROM employees WHERE department_id = dept_id);
	
END //

DELIMITER ;

# 调用
SET @dept_id := 50;
SELECT count_by_id(@dept_id);

注意：
若在创建存储函数中报错“you might want to use the less safe log_bin_trust_function_creators variable”，有两种处理方法：
方式1：加上必要的函数特性“[NOT] DETERMINISTIC”和“{CONTAINS SQL | NO SQL | READS SQL DATA | MODIFIES SQL DATA}”
方式2：
1
mysql> SET GLOBAL log_bin_trust_function_creators = 1;

对比存储函数和存储过程：
- 此外，存储函数可以放在查询语句中使用，存储过程不行。反之，存储过程的功能更加强大，包括能够执行对表的操作（比如创建表，删除表等）和事务操作，这些功能是存储函数不具备的。

5、存储过程和函数的查看、修改、删除

查看

MySQL存储了存储过程和函数的状态信息，用户可以使用SHOW STATUS语句或SHOW CREATE语句来查看，也可直接从系统的information_schema数据库中查询。这里介绍3种方法。

使用SHOW CREATE语句查看存储过程和函数的创建信息。

1	SHOW CREATE {PROCEDURE \| FUNCTION} 存储过程名或函数名

1
2
3

SHOW CREATE PROCEDURE show_mgr_name;

SHOW CREATE FUNCTION count_by_id;

使用SHOW STATUS语句查看存储过程和函数的状态信息。

1
2
3

# 这个语句返回子程序的特征，如数据库、名字、类型、创建者及创建和修改日期。
# [LIKE 'pattern']：匹配存储过程或函数的名称，可以省略。当省略不写时，会列出MySQL数据库中存在的所有存储过程或函数的信息。
SHOW {PROCEDURE | FUNCTION} STATUS [LIKE 'pattern']

1
2
3

SHOW PROCEDURE STATUS LIKE 'show_max_salary';

SHOW FUNCTION STATUS LIKE 'email_by_id';

从information_schema.Routines表中查看存储过程和函数的信息。MySQL中存储过程和函数的信息存储在information_schema数据库下的Routines表中。可以通过查询该表的记录来查询存储过程和函数的信息。其基本语法形式如下：

1
2
3

# 说明：如果在MySQL数据库中存在存储过程和函数名称相同的情况，最好指定ROUTINE_TYPE查询条件来指明查询的是存储过程还是函数。
SELECT * FROM information_schema.Routines
WHERE ROUTINE_NAME='存储过程或函数的名' [AND ROUTINE_TYPE = {'PROCEDURE|FUNCTION'}];

1 2	SELECT * FROM information_schema.Routines WHERE ROUTINE_NAME='show_min_salary' AND ROUTINE_TYPE = 'PROCEDURE';

修改

修改存储过程或函数，不影响存储过程或函数功能，只是修改相关特性。使用ALTER语句实现。
1
ALTER {PROCEDURE | FUNCTION} 存储过程或函数的名 [characteristic ...]
- 其中，characteristic指定存储过程或函数的特性，其取值信息与创建存储过程、函数时的取值信息略有不同。
  1
  2
  3
  { CONTAINS SQL | NO SQL | READS SQL DATA | MODIFIES SQL DATA }
  | SQL SECURITY { DEFINER | INVOKER }
  | COMMENT 'string'
  - CONTAINS SQL，表示子程序包含SQL语句，但不包含读或写数据的语句。
  - NO SQL，表示子程序中不包含SQL语句。
  - READS SQL DATA，表示子程序中包含读数据的语句。
  - MODIFIES SQL DATA ，表示子程序中包含写数据的语句。
  - SQL SECURITY { DEFINER | INVOKER } ，指明谁有权限来执行。
    - DEFINER ，表示只有定义者自己才能够执行。
    - INVOKER ，表示调用者可以执行。
  - COMMENT ‘string’，表示注释信息。
修改存储过程使用ALTER PROCEDURE语句，修改存储函数使用ALTER FUNCTION语句。但是，这两个语句的结构是一样的，语句中的所有参数也是一样的。
1
2
3
ALTER PROCEDURE show_max_salary
SQL SECURITY INVOKER
COMMENT '查询最高工资';

删除

删除存储过程和函数，可以使用DROP语句，其语法结构如下：

1 2	# IF EXISTS：如果程序或函数不存储，它可以防止发生错误，产生一个用SHOW WARNINGS查看的警告。 DROP {PROCEDURE \| FUNCTION} [IF EXISTS] 存储过程或函数的名

1
2
3

DROP FUNCTION IF EXISTS count_by_id;

DROP PROCEDURE IF EXISTS show_min_salary;

6、小结

存储过程优点：
- 存储过程可以一次编译多次使用。存储过程只在创建时进行编译，之后的使用都不需要重新编译，这就提升了 SQL 的执行效率。
- 可以减少开发工作量。将代码封装成模块，实际上是编程的核心思想之一，这样可以把复杂的问题拆解成不同的模块，然后模块之间可以重复使用，在减少开发工作量的同时，还能保证代码的结构清晰。
- 存储过程的安全性强。我们在设定存储过程的时候可以设置对用户的使用权限，这样就和视图一样具有较强的安全性。
- 可以减少网络传输量。因为代码封装到存储过程中，每次使用只需要调用存储过程即可，这样就减少了网络传输量。
- 良好的封装性。在进行相对复杂的数据库操作时，原本需要使用一条一条的SQL语句，可能要连接多次数据库才能完成的操作，现在变成了一次存储过程，只需要连接一次即可。
存储过程缺点：
- 可移植性差。存储过程不能跨数据库移植，比如在MySQL、Oracle和SQL Server里编写的存储过程，在换成其他数据库时都需要重新编写。
- 调试困难。只有少数 DBMS 支持存储过程的调试。对于复杂的存储过程来说，开发和维护都不容易。虽然也有一些第三方工具可以对存储过程进行调试，但要收费。
- 存储过程的版本管理很困难。比如数据表索引发生变化了，可能会导致存储过程失效。我们在开发软件的时候往往需要进行版本管理，但是存储过程本身没有版本控制，版本迭代更新的时候很麻烦。
- 它不适合高并发的场景。高并发的场景需要减少数据库的压力，有时数据库会采用分库分表的方式，而且对可扩展性要求很高，在这种情况下，存储过程会变得难以维护，增加数据库的压力，显然就不适用了。

存储过程既方便，又有局限性。尽管不同的公司对存储过程的态度不一，但是对于我们开发人员来说，不论怎样，掌握存储过程都是必备的技能之一。